[9.1] (backport #8761) ci: always include 8.19 LTS release branch in snapshots of test versions (#8783)

* ci: always include 8.19 LTS release branch in snapshots of test versions (#8761)

* ci: always include 8.19 LTS release branch in snapshots of test versions

* update .upgrade-test-agent-versions.yml

(cherry picked from commit e629b9e)

* fix: update .upgrade-test-agent-versions.yml

---------

Co-authored-by: Panos Koutsovasilis <[email protected]>

Author: mergify[bot]

magefile.go

@@ -27,6 +27,7 @@ import (
 	"regexp"
 	"runtime"
 	"slices"
+	"sort"
 	"strconv"
 	"strings"
 	"sync"
@@ -2420,20 +2421,39 @@ func (Integration) BuildKubernetesTestData(ctx context.Context) error {
 // UpdateVersions runs an update on the `.agent-versions.yml` fetching
 // the latest version list from the artifact API.
 func (Integration) UpdateVersions(ctx context.Context) error {
-	maxSnapshots := 3
+	agentVersion, err := version.ParseVersion(bversion.Agent)
+	if err != nil {
+		return fmt.Errorf("failed to parse agent version %s: %w", bversion.Agent, err)
+	}
+
+	// maxSnapshots is the maximum number of snapshots from
+	// releases branches we want to include in the snapshot list
+	maxSnapshots := 2
 
 	branches, err := git.GetReleaseBranches(ctx)
 	if err != nil {
 		return fmt.Errorf("failed to list release branches: %w", err)
 	}
 
-	// -1 because we manually add 7.17 below
-	if len(branches) > maxSnapshots-1 {
-		branches = branches[:maxSnapshots-1]
+	// limit the number of snapshot branches to the maxSnapshots
+	targetSnapshotBranches := branches[:maxSnapshots]
+
+	// we also want to always include the latest snapshot from lts release branches
+	ltsBranches := []string{
+		// 7.17 is an LTS branch so we need to include it always
+		"7.17",
+	}
+
+	// if we have a newer version of the agent, we want to include the latest snapshot from 8.19 LTS branch
+	if agentVersion.Major() > 8 || agentVersion.Major() == 8 && agentVersion.Minor() > 19 {
+		// order is important
+		ltsBranches = append([]string{"8.19"}, ltsBranches...)
 	}
 
-	// it's not a part of this repository, cannot be retrieved with `GetReleaseBranches`
-	branches = append(branches, "7.17")
+	// need to include the LTS branches, sort them and remove duplicates
+	targetSnapshotBranches = append(targetSnapshotBranches, ltsBranches...)
+	sort.Slice(targetSnapshotBranches, git.Less(targetSnapshotBranches))
+	targetSnapshotBranches = slices.Compact(targetSnapshotBranches)
 
 	// uncomment if want to have the current version snapshot on the list as well
 	// branches = append([]string{"master"}, branches...)
@@ -2443,7 +2463,7 @@ func (Integration) UpdateVersions(ctx context.Context) error {
 		CurrentMajors:    1,
 		PreviousMinors:   2,
 		PreviousMajors:   1,
-		SnapshotBranches: branches,
+		SnapshotBranches: targetSnapshotBranches,
 	}
 	b, _ := json.MarshalIndent(reqs, "", "  ")
 	fmt.Println(string(b))

pkg/testing/tools/git/git.go

@@ -41,16 +41,16 @@ func GetReleaseBranches(ctx context.Context) ([]string, error) {
 		return nil, err
 	}
 
-	sort.Slice(branchList, less(branchList))
+	sort.Slice(branchList, Less(branchList))
 
 	return branchList, nil
 }
 
 // we use this to emulate the maximum possible version value aliased by `.x`
 var maxIntString = strconv.Itoa(math.MaxInt)
 
-// less makes sure we have our release branches in the right order
-func less(branches []string) func(i, j int) bool {
+// Less makes sure we have our release branches in the right order
+func Less(branches []string) func(i, j int) bool {
 	return func(i, j int) bool {
 		// we complete the versions, so we can parse semver and compare
 		var (

pkg/testing/tools/git/git_test.go

@@ -47,7 +47,7 @@ func TestLess(t *testing.T) {
 		"wrong",
 	}
 
-	sort.Slice(branchList, less(branchList))
+	sort.Slice(branchList, Less(branchList))
 
 	require.Equal(t, expected, branchList)
 }

testing/integration/testdata/.upgrade-test-agent-versions.yml

@@ -5,8 +5,8 @@
 # upgrade integration tests.
 
 testVersions:
+  - 9.0.4-SNAPSHOT
   - 9.0.3
-  - 9.0.3-SNAPSHOT
   - 8.19.0-SNAPSHOT
   - 8.18.3
-  - 7.17.29-SNAPSHOT
+  - 7.17.30-SNAPSHOT