Command to check Rancher dependencies for a RC

cmd/rancher_release/check_rancher_rc_deps.go

@@ -0,0 +1,68 @@
+package main
+
+import (
+	"errors"
+
+	"github.com/rancher/ecm-distro-tools/release/rancher"
+	"github.com/sirupsen/logrus"
+	"github.com/urfave/cli/v2"
+)
+
+func checkRancherRCDepsCommand() *cli.Command {
+	return &cli.Command{
+		Name:  "check-rancher-rc-deps",
+		Usage: "check if the Rancher version specified by the commit or pre-release title does not contain development dependencies and rc tags",
+		Flags: []cli.Flag{
+			&cli.StringFlag{
+				Name:     "commit",
+				Aliases:  []string{"c"},
+				Usage:    "last commit for a final rc",
+				Required: false,
+			},
+			&cli.StringFlag{
+				Name:     "release-title",
+				Aliases:  []string{"t"},
+				Usage:    "release title from a given release process",
+				Required: false,
+			},
+			&cli.StringFlag{
+				Name:     "org",
+				Aliases:  []string{"o"},
+				Usage:    "organization name",
+				Required: false,
+			},
+			&cli.StringFlag{
+				Name:     "repo",
+				Aliases:  []string{"r"},
+				Usage:    "rancher repository",
+				Required: false,
+			},
+			&cli.StringFlag{
+				Name:     "files",
+				Aliases:  []string{"f"},
+				Usage:    "files to be checked",
+				Required: true,
+			},
+		},
+		Action: checkRancherRCDeps,
+	}
+}
+
+func checkRancherRCDeps(c *cli.Context) error {
+	rcReleaseTitle := c.String("release-title")
+	rcCommit := c.String("commit")
+	rcOrg := c.String("org")
+	rcRepo := c.String("repo")
+	rcFiles := c.String("files")
+
+	if rcCommit == "" && rcReleaseTitle == "" {
+		return errors.New("'commit' or 'release-title' are required")
+	}
+	if rcFiles == "" {
+		return errors.New("'files' is required, e.g, --files Dockerfile.dapper,go.mod")
+	}
+	logrus.Debugf("organization: %s, repository: %s, commit: %s, release title: %s, files: %s",
+		rcOrg, rcRepo, rcCommit, rcReleaseTitle, rcFiles)
+
+	return rancher.CheckRancherFinalRCDeps(rcOrg, rcRepo, rcCommit, rcReleaseTitle, rcFiles)
+}

cmd/rancher_release/main.go

@@ -31,6 +31,7 @@ func main() {
 		checkRancherImageCommand(),
 		setKDMBranchReferencesCommand(),
 		setChartsBranchReferencesCommand(),
+		checkRancherRCDepsCommand(),
 		labelIssuesCommand(),
 	}
 	app.Flags = rootFlags

release/rancher/rancher.go

@@ -4,8 +4,10 @@ import (
 	"bufio"
 	"context"
 	"errors"
+	"fmt"
 	"io"
 	"net/http"
+	"regexp"
 	"strconv"
 	"strings"
 	"time"
@@ -91,6 +93,11 @@ if [ "${DRY_RUN}" = false ]; then
 fi`
 )
 
+const (
+	rancherRepo = "rancher"
+	rancherOrg  = rancherRepo
+)
+
 type SetBranchReferencesArgs struct {
 	RancherRepoPath   string
 	CurrentBranch     string
@@ -263,8 +270,7 @@ func SetChartBranchReferences(ctx context.Context, forkPath, rancherBaseBranch,
 }
 
 func createPRFromRancher(ctx context.Context, rancherBaseBranch, title, branchName, forkOwner string, ghClient *github.Client) error {
-	const repo = "rancher"
-	org, err := repository.OrgFromRepo(repo)
+	org, err := repository.OrgFromRepo(rancherRepo)
 	if err != nil {
 		return err
 	}
@@ -274,7 +280,88 @@ func createPRFromRancher(ctx context.Context, rancherBaseBranch, title, branchNa
 		Head:                github.String(forkOwner + ":" + branchName),
 		MaintainerCanModify: github.Bool(true),
 	}
-	_, _, err = ghClient.PullRequests.Create(ctx, org, repo, pull)
+	_, _, err = ghClient.PullRequests.Create(ctx, org, rancherRepo, pull)
 
 	return err
 }
+
+func CheckRancherFinalRCDeps(org, repo, commitHash, releaseTitle, files string) error {
+	const (
+		releaseTitleRegex           = `^Pre-release v2\.7\.[0-9]{1,100}-rc[1-9][0-9]{0,1}$`
+		partialFinalRCCommitMessage = "last commit for final rc"
+	)
+	var (
+		matchCommitMessage bool
+		existsReleaseTitle bool
+		badFiles           bool
+	)
+
+	devDependencyPattern := regexp.MustCompile(`dev-v[0-9]+\.[0-9]+`)
+	rcTagPattern := regexp.MustCompile(`-rc[0-9]+`)
+
+	httpClient := ecmHTTP.NewClient(time.Second * 15)
+
+	if repo == "" {
+		repo = rancherRepo
+	}
+	if org == "" {
+		org = rancherOrg
+	}
+	if commitHash != "" {
+		commitData, err := repository.CommitInfo(org, repo, commitHash, &httpClient)
+		if err != nil {
+			return err
+		}
+		matchCommitMessage = strings.Contains(commitData.Message, partialFinalRCCommitMessage)
+
+	}
+	if releaseTitle != "" {
+		innerExistsReleaseTitle, err := regexp.MatchString(releaseTitleRegex, releaseTitle)
+		if err != nil {
+			return err
+		}
+		existsReleaseTitle = innerExistsReleaseTitle
+	}
+
+	if matchCommitMessage || existsReleaseTitle {
+		for _, filePath := range strings.Split(files, ",") {
+			content, err := repository.ContentByFileNameAndCommit(org, repo, commitHash, filePath, &httpClient)
+			if err != nil {
+				return err
+			}
+
+			scanner := bufio.NewScanner(strings.NewReader(string(content)))
+			lineNum := 1
+
+			for scanner.Scan() {
+				line := scanner.Text()
+				lineByte := []byte(line)
+
+				if devDependencyPattern.Match(lineByte) {
+					badFiles = true
+					logMessage := fmt.Sprintf("error: %s contains dev dependencies (line %d) - %s", filePath, lineNum, line)
+					logrus.Info(logMessage)
+				}
+				if rcTagPattern.Match(lineByte) {
+					badFiles = true
+					logMessage := fmt.Sprintf("error: %s contains rc tags (line %d) - %s", filePath, lineNum, line)
+					logrus.Info(logMessage)
+				}
+
+				lineNum++
+			}
+			if err := scanner.Err(); err != nil {
+				return err
+			}
+		}
+		if badFiles {
+			return errors.New("check failed, some files don't match the expected dependencies for a final release candidate")
+		}
+
+		logrus.Info("check completed successfully")
+		return nil
+	}
+
+	logrus.Info("skipped check")
+	return nil
+}

repository/repository.go

@@ -2,17 +2,22 @@ package repository
 
 import (
 	"context"
+	"encoding/json"
 	"errors"
 	"fmt"
+	"io/ioutil"
+	"net/http"
 	"os"
 	"os/exec"
+	"strconv"
 	"strings"
 	"time"
 
 	"github.com/go-git/go-git/v5"
 	"github.com/go-git/go-git/v5/plumbing"
 	"github.com/google/go-github/v39/github"
 	"github.com/rancher/ecm-distro-tools/types"
+	"github.com/sirupsen/logrus"
 	"golang.org/x/oauth2"
 )
 
@@ -21,6 +26,8 @@ const (
 	emptyReleaseNote   = "```release-note\r\n\r\n```"
 	noneReleaseNote    = "```release-note\r\nNONE\r\n```"
 	httpTimeout        = time.Second * 10
+	ghContentURL       = "https://raw.githubusercontent.com"
+	baseURLGHApi       = "https://api.github.com"
 )
 
 // repoToOrg associates repo to org.
@@ -457,3 +464,75 @@ To find more information on specific steps, please see documentation [here](http
 - [ ] QA: Final validation of above PR and tracked through the linked ticket
 - [ ] PJM: Close the milestone in GitHub.
 `
+
+type Author struct {
+	Name  string `json:"name"`
+	Email string `json:"email"`
+	Date  string `json:"date"`
+}
+
+type Commit struct {
+	Author    Author `json:"author"`
+	Committer Author `json:"committer"`
+	Message   string `json:"message"`
+	URL       string `json:"url"`
+}
+
+type CommitResponse struct {
+	SHA         string `json:"sha"`
+	NodeID      string `json:"node_id"`
+	Commit      Commit `json:"commit"`
+	URL         string `json:"url"`
+	HTMLURL     string `json:"html_url"`
+	CommentsURL string `json:"comments_url"`
+}
+
+func CommitInfo(owner, repo, commitHash string, httpClient *http.Client) (*Commit, error) {
+	apiUrl := fmt.Sprintf(baseURLGHApi+"/repos/%s/%s/commits/%s", owner, repo, commitHash)
+
+	response, err := httpClient.Get(apiUrl)
+	if err != nil {
+		logrus.Debug("Error making request:", err)
+		return nil, err
+	}
+	defer response.Body.Close()
+	if response.StatusCode != http.StatusOK {
+		return nil, errors.New("failed to fetch commit information. status code: " + strconv.Itoa(response.StatusCode))
+	}
+	data, err := ioutil.ReadAll(response.Body)
+	if err != nil {
+		logrus.Debug("error reading response body:", err)
+		return nil, err
+	}
+
+	var commitResponse CommitResponse
+
+	err = json.Unmarshal([]byte(data), &commitResponse)
+	if err != nil {
+		logrus.Debug("error unmarshaling JSON:", err)
+		return nil, err
+	}
+
+	return &commitResponse.Commit, nil
+}
+
+func ContentByFileNameAndCommit(owner, repo, commitHash, filePath string, httpClient *http.Client) ([]byte, error) {
+	rawURL := fmt.Sprintf(ghContentURL+"/%s/%s/%s/%s", owner, repo, commitHash, filePath)
+
+	response, err := http.Get(rawURL)
+	if err != nil {
+		logrus.Debug("error fetching raw file:", err)
+		return nil, err
+	}
+	defer response.Body.Close()
+	if response.StatusCode != http.StatusOK {
+		return nil, errors.New("failed to fetch raw file. status code: " + strconv.Itoa(response.StatusCode))
+	}
+	data, err := ioutil.ReadAll(response.Body)
+	if err != nil {
+		logrus.Debug("error reading response body:", err)
+		return nil, err
+	}
+
+	return data, nil
+}