obs-staging-bot: allow build-disabling repositories in the QA projects

Using the BuildDisableRepos configuration, it is now possible to
define which repositories to build-disable in the QA project meta.

This is for example useful for the SLES development workflow, where
the product repository should only be enabled after the packagelist
definitions have been built - so it is not desirable to have them
built as soon as the QA project is created.

Example:

    {
      "ObsProject": "SUSE:SLFO:Main",
      "StagingProject": "SUSE:SLFO:Main:PullRequest",
      "QA": [
        {
          "Name": "SLES",
          "Origin": "SUSE:SLFO:Products:SLES:16.1",
          "BuildDisableRepos": ["product"]
        }
      ]
    }

Signed-off-by: Eugenio Paolantonio <eugenio.paolantonio@suse.com>

common/config.go

@@ -54,6 +54,7 @@ type ReviewGroup struct {
 type QAConfig struct {
 	Name   string
 	Origin string
+	BuildDisableRepos []string // which repos to build disable in the new project
 }
 
 type Permissions struct {
@@ -91,7 +92,6 @@ type AutogitConfig struct {
 	NoProjectGitPR     bool // do not automatically create project git PRs, just assign reviewers and assume somethign else creates the ProjectGit PR
 	ManualMergeOnly    bool // only merge with "Merge OK" comment by Project Maintainers and/or Package Maintainers and/or reviewers
 	ManualMergeProject bool // require merge of ProjectGit PRs with "Merge OK" by ProjectMaintainers and/or reviewers
-	ReviewRequired     bool // always require a maintainer review, even if maintainer submits it. Only ignored if no other package or project reviewers
 }
 
 type AutogitConfigs []*AutogitConfig
@@ -293,9 +293,9 @@ func (config *AutogitConfig) GetRemoteBranch() string {
 }
 
 func (config *AutogitConfig) Label(label string) string {
-	if t, found := config.Labels[LabelKey(label)]; found {
-		return t
-	}
+		if t, found := config.Labels[LabelKey(label)]; found {
+			return t
+		}
 
 	return label
 }

common/maintainership.go

@@ -25,7 +25,6 @@ const ProjectFileKey = "_project"
 type MaintainershipMap struct {
 	Data         map[string][]string
 	IsDir        bool
-	Config       *AutogitConfig
 	FetchPackage func(string) ([]byte, error)
 }
 
@@ -40,9 +39,7 @@ func parseMaintainershipData(data []byte) (*MaintainershipMap, error) {
 	return maintainers, nil
 }
 
-func FetchProjectMaintainershipData(gitea GiteaMaintainershipReader, config *AutogitConfig) (*MaintainershipMap, error) {
-	org, prjGit, branch := config.GetPrjGit()
-
+func FetchProjectMaintainershipData(gitea GiteaMaintainershipReader, org, prjGit, branch string) (*MaintainershipMap, error) {
 	data, _, err := gitea.FetchMaintainershipDirFile(org, prjGit, branch, ProjectFileKey)
 	dir := true
 	if err != nil || data == nil {
@@ -64,7 +61,6 @@ func FetchProjectMaintainershipData(gitea GiteaMaintainershipReader, config *Aut
 
 	m, err := parseMaintainershipData(data)
 	if m != nil {
-		m.Config = config
 		m.IsDir = dir
 		m.FetchPackage = func(pkg string) ([]byte, error) {
 			data, _, err := gitea.FetchMaintainershipDirFile(org, prjGit, branch, pkg)
@@ -153,10 +149,7 @@ func (data *MaintainershipMap) IsApproved(pkg string, reviews []*models.PullRevi
 	}
 
 	LogDebug("Looking for review by:", reviewers)
-	slices.Sort(reviewers)
-	reviewers = slices.Compact(reviewers)
-	SubmitterIdxInReviewers := slices.Index(reviewers, submitter)
-	if SubmitterIdxInReviewers > -1 && (!data.Config.ReviewRequired || len(reviewers) == 1) {
+	if slices.Contains(reviewers, submitter) {
 		LogDebug("Submitter is maintainer. Approving.")
 		return true
 	}

common/maintainership_test.go

@@ -13,10 +13,10 @@ import (
 )
 
 func TestMaintainership(t *testing.T) {
-	config := &common.AutogitConfig{
+	config := common.AutogitConfig{
 		Branch:         "bar",
 		Organization:   "foo",
-		GitProjectName: common.DefaultGitPrj + "#bar",
+		GitProjectName: common.DefaultGitPrj,
 	}
 
 	packageTests := []struct {
@@ -141,7 +141,7 @@ func TestMaintainership(t *testing.T) {
 	notFoundError := repository.NewRepoGetContentsNotFound()
 	for _, test := range packageTests {
 		runTests := func(t *testing.T, mi common.GiteaMaintainershipReader) {
-			maintainers, err := common.FetchProjectMaintainershipData(mi, config)
+			maintainers, err := common.FetchProjectMaintainershipData(mi, config.Organization, config.GitProjectName, config.Branch)
 			if err != nil && !test.otherError {
 				if test.maintainersFileErr == nil {
 					t.Fatal("Unexpected error recieved", err)
@@ -253,43 +253,3 @@ func TestMaintainershipFileWrite(t *testing.T) {
 		})
 	}
 }
-
-func TestReviewRequired(t *testing.T) {
-	tests := []struct {
-		name        string
-		maintainers []string
-		config      *common.AutogitConfig
-		is_approved bool
-	}{
-		{
-			name:        "ReviewRequired=false",
-			maintainers: []string{"maintainer1", "maintainer2"},
-			config:      &common.AutogitConfig{ReviewRequired: false},
-			is_approved: true,
-		},
-		{
-			name:        "ReviewRequired=true",
-			maintainers: []string{"maintainer1", "maintainer2"},
-			config:      &common.AutogitConfig{ReviewRequired: true},
-			is_approved: false,
-		},
-		{
-			name:        "ReviewRequired=true",
-			maintainers: []string{"maintainer1"},
-			config:      &common.AutogitConfig{ReviewRequired: true},
-			is_approved: true,
-		},
-	}
-
-	for _, test := range tests {
-		t.Run(test.name, func(t *testing.T) {
-			m := &common.MaintainershipMap{
-				Data: map[string][]string{"": test.maintainers},
-			}
-			m.Config = test.config
-			if approved := m.IsApproved("", nil, "maintainer1", nil); approved != test.is_approved {
-				t.Error("Expected m.IsApproved()->", test.is_approved, "but didn't get it")
-			}
-		})
-	}
-}

common/pr.go

@@ -316,10 +316,7 @@ func (rs *PRSet) FindMissingAndExtraReviewers(maintainers MaintainershipData, id
 		// only need project maintainer reviews if:
 		//    * not created by a bot and has other PRs, or
 		//    * not created by maintainer
-		noReviewPRCreators := []string{}
-		if !rs.Config.ReviewRequired {
-			noReviewPRCreators = prjMaintainers
-		}
+		noReviewPRCreators := prjMaintainers
 		if len(rs.PRs) > 1 {
 			noReviewPRCreators = append(noReviewPRCreators, rs.BotUser)
 		}
@@ -342,10 +339,7 @@ func (rs *PRSet) FindMissingAndExtraReviewers(maintainers MaintainershipData, id
 		pkg := pr.PR.Base.Repo.Name
 		pkgMaintainers := maintainers.ListPackageMaintainers(pkg, nil)
 		Maintainers := slices.Concat(prjMaintainers, pkgMaintainers)
-		noReviewPkgPRCreators := []string{}
-		if !rs.Config.ReviewRequired {
-			noReviewPkgPRCreators = pkgMaintainers
-		}
+		noReviewPkgPRCreators := pkgMaintainers
 
 		LogDebug("packakge maintainers:", Maintainers)
 

common/pr_test.go

@@ -833,6 +833,7 @@ func TestFindMissingAndExtraReviewers(t *testing.T) {
 				[]string{"autogits_obs_staging_bot", "user1"},
 			},
 		},
+
 		{
 			name: "Add reviewer if also maintainer where review by maintainer is not needed",
 			prset: &common.PRSet{
@@ -1094,67 +1095,8 @@ func TestFindMissingAndExtraReviewers(t *testing.T) {
 			expected_missing_reviewers: [][]string{{"pkgm2", "prj2"}},
 			expected_extra_reviewers:   [][]string{{}, {"prj1"}},
 		},
-		{
-			name: "Package maintainer submitter, AlwaysRequireReview=false",
-			prset: &common.PRSet{
-				PRs: []*common.PRInfo{
-					{
-						PR: &models.PullRequest{
-							User: &models.User{UserName: "pkgmaintainer"},
-							Base: &models.PRBranchInfo{Name: "main", Repo: &models.Repository{Name: "pkg", Owner: &models.User{UserName: "org"}}},
-						},
-						Reviews: &common.PRReviews{},
-					},
-				},
-				Config: &common.AutogitConfig{
-					GitProjectName: "prg/repo#main",
-					Organization:   "org",
-					Branch:         "main",
-					Reviewers:      []string{},
-					ReviewRequired: false,
-				},
-			},
-			maintainers: &common.MaintainershipMap{
-				Data: map[string][]string{
-					"pkg": {"pkgmaintainer", "pkgm1"},
-				},
-			},
-			noAutoStaging: true,
-			expected_missing_reviewers: [][]string{
-				{},
-			},
-		},
-		{
-			name: "Package maintainer submitter, AlwaysRequireReview=true",
-			prset: &common.PRSet{
-				PRs: []*common.PRInfo{
-					{
-						PR: &models.PullRequest{
-							User: &models.User{UserName: "pkgmaintainer"},
-							Base: &models.PRBranchInfo{Name: "main", Repo: &models.Repository{Name: "pkg", Owner: &models.User{UserName: "org"}}},
-						},
-						Reviews: &common.PRReviews{},
-					},
-				},
-				Config: &common.AutogitConfig{
-					GitProjectName: "prg/repo#main",
-					Organization:   "org",
-					Branch:         "main",
-					Reviewers:      []string{},
-					ReviewRequired: true,
-				},
-			},
-			maintainers: &common.MaintainershipMap{
-				Data: map[string][]string{
-					"pkg": {"pkgmaintainer", "pkgm1"},
-				},
-			},
-			noAutoStaging: true,
-			expected_missing_reviewers: [][]string{
-				{"pkgm1"},
-			},
-		},
 	}
+
 	for _, test := range tests {
 		t.Run(test.name, func(t *testing.T) {
 			test.prset.HasAutoStaging = !test.noAutoStaging

obs-staging-bot/README.md

@@ -34,7 +34,8 @@ It's a JSON file with following syntax:
  "QA": [
    {
      "Name": "SLES",
-     "Origin": "SUSE:SLFO:Products:SLES:16.0"
+     "Origin": "SUSE:SLFO:Products:SLES:16.0",
+     "BuildDisableRepos": ["product"]
    }
  ]
 }
@@ -47,6 +48,7 @@ It's a JSON file with following syntax:
 | *QA* | Crucial for generating a product build (such as an ISO or FTP tree) that incorporates the packages. | no | array of objects | | |
 | *QA > Name* | Suffix for the QA OBS staging project. The project is named *StagingProject:<PR_Number>:Name*. | no | string | | |
 | *QA > Origin* | OBS reference project | no | string | | |
+| *QA > BuildDisableRepos* | The names of OBS repositories to build-disable, if any. | no | array of strings | | [] |
 
 
 Details
@@ -65,6 +67,6 @@ Details
 * **PrjGit PR - QA staging project**
   * The QA staging project is meant for building the product; the relative build config is inherited from the `QA > Origin` project.
   * In this case, the **scmsync** tag is inherited from the `QA > Origin` project.
-
-
+  * It is desirable in some cases to avoid building some specific build service repositories when not needed. In this case, `QA > BuildDisableRepos` can be specified.
+    These repositories would be disabled in the project meta when generating the QA project.
 

obs-staging-bot/main.go

@@ -109,6 +109,11 @@ const (
 	BuildStatusSummaryUnknown  = 4
 )
 
+type DisableFlag struct {
+	XMLName string `xml:"disable"`
+	Name    string `xml:"repository,attr"`
+}
+
 func ProcessBuildStatus(project, refProject *common.BuildResultList) BuildStatusSummary {
 	if _, finished := refProject.BuildResultSummary(); !finished {
 		common.LogDebug("refProject not finished building??")
@@ -377,7 +382,7 @@ func GenerateObsPrjMeta(git common.Git, gitea common.Gitea, pr *models.PullReque
 // stagingProject:$buildProject
 //  ^-  stagingProject:$buildProject:$subProjectName (based on templateProject)
 
-func CreateQASubProject(stagingConfig *common.StagingConfig, git common.Git, gitea common.Gitea, pr *models.PullRequest, stagingProject, templateProject, subProjectName string) error {
+func CreateQASubProject(stagingConfig *common.StagingConfig, git common.Git, gitea common.Gitea, pr *models.PullRequest, stagingProject, templateProject, subProjectName string, buildDisableRepos []string) error {
 	common.LogDebug("Setup QA sub projects")
 	templateMeta, err := ObsClient.GetProjectMeta(templateProject)
 	if err != nil {
@@ -407,7 +412,21 @@ func CreateQASubProject(stagingConfig *common.StagingConfig, git common.Git, git
 		repository.Fragment  = branch.SHA
 		templateMeta.ScmSync = repository.String()
 		common.LogDebug("Setting scmsync url to ", templateMeta.ScmSync)
-        }
+	}
+	// Build-disable repositories if asked
+	if len(buildDisableRepos) > 0 {
+		toDisable := make([]DisableFlag, len(buildDisableRepos))
+		for idx, repositoryName := range buildDisableRepos {
+			toDisable[idx] = DisableFlag{Name: repositoryName}
+		}
+
+		output, err := xml.Marshal(toDisable)
+		if err != nil {
+			common.LogError("error while marshalling, skipping BuildDisableRepos: ", err)
+		} else {
+			templateMeta.BuildFlags.Contents += string(output)
+		}
+	}
 	// Cleanup ReleaseTarget and modify affected path entries
 	for idx, r := range templateMeta.Repositories {
 		templateMeta.Repositories[idx].ReleaseTargets = nil
@@ -922,7 +941,8 @@ func ProcessPullRequest(gitea common.Gitea, org, repo string, id int64) (bool, e
 				CreateQASubProject(stagingConfig, git, gitea, pr,
 					stagingProject,
 					setup.Origin,
-					setup.Name)
+					setup.Name,
+					setup.BuildDisableRepos)
 				msg = msg + ObsWebHost + "/project/show/" +
 					stagingProject + ":" + setup.Name + "\n"
 			}

workflow-pr/README.md

@@ -52,7 +52,7 @@ Config file
 | *GitProjectName* | Repository and branch where the ProjectGit lives. | no | string | **Format**: `org/project_repo#branch` | By default assumes `_ObsPrj` with default branch in the *Organization* |
 | *ManualMergeOnly* | Merges are permitted only upon receiving a "merge ok" comment from designated maintainers in the PkgGit PR. | no | bool | true, false | false |
 | *ManualMergeProject* | Merges are permitted only upon receiving a "merge ok" comment in the ProjectGit PR from project maintainers. | no | bool | true, false | false |
-| *ReviewRequired* | If submitter is a maintainer, require review from another maintainer if available. | no | bool | true, false | false |
+| *ReviewRequired* | (NOT IMPLEMENTED) If submitter is a maintainer, require review from another maintainer if available. | no | bool | true, false | false |
 | *NoProjectGitPR* | Do not create PrjGit PR, but still perform other tasks. | no | bool | true, false | false |
 | *Reviewers* | PrjGit reviewers. Additional review requests are triggered for associated PkgGit PRs. PrjGit PR is merged only when all reviews are complete. | no | array of strings | | `[]` |
 | *ReviewGroups* | If a group is specified in Reviewers, its members are listed here. | no | array of objects | | `[]` |
@@ -160,4 +160,4 @@ Server configuration
 
 | Field | Type | Notes |
 | ----- | ----- | ----- |
-| root | Array of string  | Format **org/repo\#branch** |
+| root | Array of string  | Format **org/repo\#branch** |

workflow-pr/pr_processor.go

@@ -500,7 +500,7 @@ func (pr *PRProcessor) Process(req *models.PullRequest) error {
 	// make sure that prjgit is consistent and only submodules that are to be *updated*
 	// reset anything that changed that is not part of the prset
 	// package removals/additions are *not* counted here
-
+	org, repo, branch := config.GetPrjGit()
 	// TODO: this is broken...
 	if pr, err := prset.GetPrjGitPR(); err == nil && false {
 		common.LogDebug("Submodule parse begin")
@@ -549,7 +549,7 @@ func (pr *PRProcessor) Process(req *models.PullRequest) error {
 	} else {
 		common.LogInfo("* No prjgit")
 	}
-	maintainers, err := common.FetchProjectMaintainershipData(Gitea, config)
+	maintainers, err := common.FetchProjectMaintainershipData(Gitea, org, repo, branch)
 	if err != nil {
 		return err
 	}