Merge pull request #90 from AlayaCare/collectWarnings

collecting detailed errors and warnings

browser/goliac-ui/src/components/DashboardApp.vue

@@ -19,6 +19,35 @@
 
         </el-table>
       </el-row>
+      <el-row v-if="detailedErrors.length > 0 || detailedWarnings.length > 0">
+        <el-divider />
+      </el-row>
+      <el-row v-if="detailedErrors.length > 0">
+        <el-table
+            :data="detailedErrors"
+            :stripe="true"
+            :highlight-current-row="false"
+        >
+            <el-table-column prop="Errors" align="left" label="Errors">
+                <template #default="{row}">
+                    <span>{{ row }}</span>
+                </template>
+            </el-table-column>
+        </el-table>
+      </el-row>
+      <el-row v-if="detailedWarnings.length > 0">
+        <el-table
+            :data="detailedWarnings"
+            :stripe="true"
+            :highlight-current-row="false"
+        >
+            <el-table-column prop="Warnings" align="left" label="Warnings">
+                <template #default="{row}">
+                    <span>{{ row }}</span>
+                </template>
+            </el-table-column>
+        </el-table>
+      </el-row>
       <el-row>
         <el-divider />
       </el-row>
@@ -38,7 +67,7 @@
             <span> &nbsp; </span>
             <el-button @click="flushcache">Flush cache</el-button>
         </div>
-      </el-row>  
+      </el-row>
       <el-row>
         <el-divider />
       </el-row>
@@ -71,6 +100,8 @@
       return {
         flushcacheVisible: false,
         statusTable: [],
+        detailedErrors: [],
+        detailedWarnings: [],
         version: "",
       };
     },
@@ -82,6 +113,8 @@
             Axios.get(`${API_URL}/status`).then(response => {
                 let status = response.data;
                 this.version = status.version;
+                this.detailedErrors = status.detailedErrors;
+                this.detailedWarnings = status.detailedWarnings;
                 this.statusTable = [
                     {
                         key: "Last Sync",

cmd/goliac/main.go

@@ -60,7 +60,7 @@ branch can be passed by parameter or by defining GOLIAC_SERVER_GIT_BRANCH env va
 			if err != nil {
 				logrus.Fatalf("failed to create goliac: %s", err)
 			}
-			err = goliac.Apply(true, repo, branch, true)
+			err, _, _ = goliac.Apply(true, repo, branch, true)
 			if err != nil {
 				logrus.Errorf("Failed to plan: %v", err)
 			}
@@ -93,7 +93,7 @@ branch can be passed by parameter or by defining GOLIAC_SERVER_GIT_BRANCH env va
 			if err != nil {
 				logrus.Fatalf("failed to create goliac: %s", err)
 			}
-			err = goliac.Apply(false, repo, branch, true)
+			err, _, _ = goliac.Apply(false, repo, branch, true)
 			if err != nil {
 				logrus.Errorf("Failed to apply: %v", err)
 			}

docs/api_docs/bundle.yaml

@@ -445,6 +445,14 @@ definitions:
         x-omitempty: false
       version:
         type: string
+      detailedErrors:
+        type: array
+        items:
+          type: string
+      detailedWarnings:
+        type: array
+        items:
+          type: string
   error:
     type: object
     required:

docs/troubleshooting.md

@@ -40,3 +40,10 @@ To do so, as a Gitbub admin, you can go to
 Note:
 - When Goliac will run (and its cache expires), it will put back the ruleset. Usually the cache is set to 86400 seconds (ie 1 day).
 - if you want to re-apply the ruleset quickly (when you have finished with your emergency chage), you can go to the Goliac UI and click on the `Flush cache` button, and then click on the `Re-Sync` button.
+
+## How to resolve "not enough owners for team filename XXX" warning
+
+This error is happening if a team does not have enough owners.
+Indeed a team must have at least 2 owners to be able to review and merge PRs (and the only owner cannot approve its own PRs).
+
+As an admin you should add more owners to the team.

internal/entity/team.go

@@ -132,7 +132,7 @@ func (t *Team) Validate(dirname string, users map[string]*User) (error, []Warnin
 	// warnings
 
 	if len(t.Spec.Owners) < 2 {
-		warnings = append(warnings, fmt.Errorf("no enough owner for team filename %s/team.yaml", dirname))
+		warnings = append(warnings, fmt.Errorf("not enough owners for team filename %s/team.yaml", dirname))
 	}
 
 	return nil, warnings

internal/goliac.go

@@ -26,8 +26,9 @@ const (
  * It is used to load and validate a goliac repository and apply it to github.
  */
 type Goliac interface {
-	// will run and apply the reconciliation
-	Apply(dryrun bool, repositoryUrl, branch string, forcesync bool) error
+	// will run and apply the reconciliation,
+	// it returns an error if something went wrong, and a detailed list of errors and warnings
+	Apply(dryrun bool, repositoryUrl, branch string, forcesync bool) (error, []error, []entity.Warning)
 
 	// will clone run the user-plugin to sync users, and will commit to the team repository
 	UsersUpdate(repositoryUrl, branch string, dryrun bool, force bool) error
@@ -77,42 +78,42 @@ func (g *GoliacImpl) FlushCache() {
 	g.remote.FlushCache()
 }
 
-func (g *GoliacImpl) Apply(dryrun bool, repositoryUrl, branch string, forcesync bool) error {
-	err := g.loadAndValidateGoliacOrganization(repositoryUrl, branch)
+func (g *GoliacImpl) Apply(dryrun bool, repositoryUrl, branch string, forcesync bool) (error, []error, []entity.Warning) {
+	err, errs, warns := g.loadAndValidateGoliacOrganization(repositoryUrl, branch)
 	defer g.local.Close()
 	if err != nil {
-		return fmt.Errorf("failed to load and validate: %s", err)
+		return fmt.Errorf("failed to load and validate: %s", err), errs, warns
 	}
 	u, err := url.Parse(repositoryUrl)
 	if err != nil {
-		return fmt.Errorf("failed to parse %s: %v", repositoryUrl, err)
+		return fmt.Errorf("failed to parse %s: %v", repositoryUrl, err), errs, warns
 	}
 
 	teamsreponame := strings.TrimSuffix(path.Base(u.Path), filepath.Ext(path.Base(u.Path)))
 
 	err = g.applyToGithub(dryrun, teamsreponame, branch, forcesync)
 	if err != nil {
-		return err
+		return err, errs, warns
 	}
-	return nil
+	return nil, errs, warns
 }
 
-func (g *GoliacImpl) loadAndValidateGoliacOrganization(repositoryUrl, branch string) error {
+func (g *GoliacImpl) loadAndValidateGoliacOrganization(repositoryUrl, branch string) (error, []error, []entity.Warning) {
 	var errs []error
 	var warns []entity.Warning
 	if strings.HasPrefix(repositoryUrl, "https://") || strings.HasPrefix(repositoryUrl, "git@") {
 		accessToken, err := g.githubClient.GetAccessToken()
 		if err != nil {
-			return err
+			return err, nil, nil
 		}
 
 		err = g.local.Clone(accessToken, repositoryUrl, branch)
 		if err != nil {
-			return fmt.Errorf("unable to clone: %v", err)
+			return fmt.Errorf("unable to clone: %v", err), nil, nil
 		}
 		repoconfig, err := g.local.LoadRepoConfig()
 		if err != nil {
-			return fmt.Errorf("unable to read goliac.yaml config file: %v", err)
+			return fmt.Errorf("unable to read goliac.yaml config file: %v", err), nil, nil
 		}
 		g.repoconfig = repoconfig
 
@@ -130,10 +131,10 @@ func (g *GoliacImpl) loadAndValidateGoliacOrganization(repositoryUrl, branch str
 		for _, err := range errs {
 			logrus.Error(err)
 		}
-		return fmt.Errorf("Not able to load and validate the goliac organization: see logs")
+		return fmt.Errorf("not able to load and validate the goliac organization: see logs"), errs, warns
 	}
 
-	return nil
+	return nil, errs, warns
 }
 
 /*

internal/goliac_server.go

@@ -53,6 +53,8 @@ type GoliacServerImpl struct {
 	ready               bool // when the server has finished to load the local configuration
 	lastSyncTime        *time.Time
 	lastSyncError       error
+	detailedErrors      []error
+	detailedWarnings    []entity.Warning
 	syncInterval        int64 // in seconds time remaining between 2 sync
 	notificationService notification.NotificationService
 }
@@ -419,17 +421,29 @@ func (g *GoliacServerImpl) GetUser(params app.GetUserParams) middleware.Responde
 
 func (g *GoliacServerImpl) GetStatus(app.GetStatusParams) middleware.Responder {
 	s := models.Status{
-		LastSyncError:   "",
-		LastSyncTime:    "N/A",
-		NbRepos:         int64(len(g.goliac.GetLocal().Repositories())),
-		NbTeams:         int64(len(g.goliac.GetLocal().Teams())),
-		NbUsers:         int64(len(g.goliac.GetLocal().Users())),
-		NbUsersExternal: int64(len(g.goliac.GetLocal().ExternalUsers())),
-		Version:         config.GoliacBuildVersion,
+		LastSyncError:    "",
+		LastSyncTime:     "N/A",
+		NbRepos:          int64(len(g.goliac.GetLocal().Repositories())),
+		NbTeams:          int64(len(g.goliac.GetLocal().Teams())),
+		NbUsers:          int64(len(g.goliac.GetLocal().Users())),
+		NbUsersExternal:  int64(len(g.goliac.GetLocal().ExternalUsers())),
+		Version:          config.GoliacBuildVersion,
+		DetailedErrors:   make([]string, 0),
+		DetailedWarnings: make([]string, 0),
 	}
 	if g.lastSyncError != nil {
 		s.LastSyncError = g.lastSyncError.Error()
 	}
+	if g.detailedErrors != nil {
+		for _, err := range g.detailedErrors {
+			s.DetailedErrors = append(s.DetailedErrors, err.Error())
+		}
+	}
+	if g.detailedWarnings != nil {
+		for _, warn := range g.detailedWarnings {
+			s.DetailedWarnings = append(s.DetailedWarnings, warn.Error())
+		}
+	}
 	if g.lastSyncTime != nil {
 		s.LastSyncTime = g.lastSyncTime.UTC().Format("2006-01-02T15:04:05")
 	}
@@ -547,7 +561,7 @@ func (g *GoliacServerImpl) Serve() {
  * - if the lobby is busy, it will do nothing
  */
 func (g *GoliacServerImpl) triggerApply(forceresync bool) {
-	err, applied := g.serveApply(forceresync)
+	err, errs, warns, applied := g.serveApply(forceresync)
 	if !applied && err == nil {
 		// the run was skipped
 		g.syncInterval = config.Config.ServerApplyInterval
@@ -556,6 +570,8 @@ func (g *GoliacServerImpl) triggerApply(forceresync bool) {
 		g.lastSyncTime = &now
 		previousError := g.lastSyncError
 		g.lastSyncError = err
+		g.detailedErrors = errs
+		g.detailedWarnings = warns
 		// log the error only if it's a new one
 		if err != nil && (previousError == nil || err.Error() != previousError.Error()) {
 			logrus.Error(err)
@@ -604,14 +620,14 @@ func (g *GoliacServerImpl) StartRESTApi() (*restapi.Server, error) {
 	return server, nil
 }
 
-func (g *GoliacServerImpl) serveApply(forceresync bool) (error, bool) {
+func (g *GoliacServerImpl) serveApply(forceresync bool) (error, []error, []entity.Warning, bool) {
 	// we want to run ApplyToGithub
 	// and queue one new run (the lobby) if a new run is asked
 	g.applyLobbyMutex.Lock()
 	// we already have a current run, and another waiting in the lobby
 	if g.applyLobby {
 		g.applyLobbyMutex.Unlock()
-		return nil, false
+		return nil, nil, nil, false
 	}
 
 	if !g.applyCurrent {
@@ -640,18 +656,18 @@ func (g *GoliacServerImpl) serveApply(forceresync bool) (error, bool) {
 	branch := config.Config.ServerGitBranch
 
 	if repo == "" {
-		return fmt.Errorf("GOLIAC_SERVER_GIT_REPOSITORY env variable not set"), false
+		return fmt.Errorf("GOLIAC_SERVER_GIT_REPOSITORY env variable not set"), nil, nil, false
 	}
 	if branch == "" {
-		return fmt.Errorf("GOLIAC_SERVER_GIT_BRANCH env variable not set"), false
+		return fmt.Errorf("GOLIAC_SERVER_GIT_BRANCH env variable not set"), nil, nil, false
 	}
 
 	// we are ready (to give local state, and to sync with remote)
 	g.ready = true
 
-	err := g.goliac.Apply(false, repo, branch, forceresync)
+	err, errs, warns := g.goliac.Apply(false, repo, branch, forceresync)
 	if err != nil {
-		return fmt.Errorf("failed to apply on branch %s: %s", branch, err), false
+		return fmt.Errorf("failed to apply on branch %s: %s", branch, err), errs, warns, false
 	}
-	return nil, true
+	return nil, errs, warns, true
 }

internal/goliac_server_test.go

@@ -107,8 +107,8 @@ type GoliacMock struct {
 	local engine.GoliacLocalResources
 }
 
-func (g *GoliacMock) Apply(dryrun bool, repo string, branch string, forceresync bool) error {
-	return nil
+func (g *GoliacMock) Apply(dryrun bool, repo string, branch string, forceresync bool) (error, []error, []entity.Warning) {
+	return nil, nil, nil
 }
 func (g *GoliacMock) UsersUpdate(repositoryUrl, branch string, dryrun bool, force bool) error {
 	return nil

swagger/index.yaml

@@ -272,6 +272,14 @@ definitions:
         x-omitempty: false
       version:
         type: string
+      detailedErrors:
+        type: array
+        items:
+          type: string
+      detailedWarnings:
+        type: array
+        items:
+          type: string
 
   # Default Error
   error: