Merge branch 'main' into fix-update-concurrency-group-expression-in-e2e-wor

Author: chmouel

.github/workflows/e2e.yaml

@@ -80,10 +80,15 @@ jobs:
       - uses: ko-build/setup-ko@v0.9
 
       - name: Install gosmee
-        uses: jaxxstorm/action-install-gh-release@v2.0.0
+        uses: jaxxstorm/action-install-gh-release@v2.1.0
         with:
           repo: chmouel/gosmee
 
+      - name: Install Snazy
+        uses: jaxxstorm/action-install-gh-release@v2.0.0
+        with:
+          repo: chmouel/snazy
+
       - name: Run gosmee
         run: |
           nohup gosmee client --saveDir /tmp/gosmee-replay ${{ secrets.PYSMEE_URL }} "http://${CONTROLLER_DOMAIN_URL}" &

docs/content/docs/install/metrics.md

@@ -12,6 +12,17 @@ You can configure these exporters by referring to the [observability configurati
 
 | Name                                                 | Type    | Description                                                        |
 |------------------------------------------------------|---------|--------------------------------------------------------------------|
+| `pipelines_as_code_git_provider_api_request_count`   | Counter | Number of API requests submitted to git providers                  |
 | `pipelines_as_code_pipelinerun_count`                | Counter | Number of pipelineruns created by pipelines-as-code                |
 | `pipelines_as_code_pipelinerun_duration_seconds_sum` | Counter | Number of seconds all pipelineruns have taken in pipelines-as-code |
 | `pipelines_as_code_running_pipelineruns_count`       | Gauge   | Number of running pipelineruns in pipelines-as-code                |
+
+**Note:** The metric `pipelines_as_code_git_provider_api_request_count`
+is emitted by both the Controller and the Watcher, since both services
+use Git providers' APIs. When analyzing this metric, you may need to
+combine both services' metrics. For example, using PromQL:
+
+- `sum (pac_controller_pipelines_as_code_git_provider_api_request_count or pac_watcher_pipelines_as_code_git_provider_api_request_count)`
+- `sum (rate(pac_controller_pipelines_as_code_git_provider_api_request_count[1m]) or rate(pac_watcher_pipelines_as_code_git_provider_api_request_count[1m]))`
+
+![Prometheus query for git provider API usage metrics combined from both the Watcher and the Controller](/images/git-api-usage-metrics-prometheus-query.png)

docs/static/images/git-api-usage-metrics-prometheus-query.png

@@ -97,6 +97,17 @@ collect_logs() {
   local github_ghe_smee_url="${TEST_GITHUB_SECOND_SMEE_URL}"
 
   mkdir -p /tmp/logs
+  # Output logs to stdout so we can see via the web interface directly
+  kubectl logs -n pipelines-as-code -l app.kubernetes.io/part-of=pipelines-as-code \
+    --all-containers=true --tail=1000 >/tmp/logs/pac-pods.log
+  if command -v "snazy" >/dev/null 2>&1; then
+    snazy --skip-line-regexp="^(Reconcile (succeeded|error)|Updating webhook)" /tmp/logs/pac-pods.log
+  else
+    # snazy for the poors
+    python -c "import sys,json,datetime; [print(f'• { (lambda t: datetime.datetime.fromisoformat(t.rstrip(\"Z\")).strftime(\"%H:%M:%S\") if isinstance(t,str) else datetime.datetime.fromtimestamp(t).strftime(\"%H:%M:%S\"))(json.loads(l.strip())[\"ts\"] )} {json.loads(l.strip()).get(\"msg\",\"\")}') if l.strip().startswith('{') else print(l.strip()) for l in sys.stdin]" \
+      </tmp/logs/pac-pods.log
+  fi
+
   kind export logs /tmp/logs
   [[ -d /tmp/gosmee-replay ]] && cp -a /tmp/gosmee-replay /tmp/logs/
 

hack/gh-workflow-ci.sh

@@ -3,11 +3,7 @@ package prompt
 import "github.com/AlecAivazis/survey/v2"
 
 // SurveyAskOne ask one question to be stubbed later.
-var SurveyAskOne = func(p survey.Prompt, response any, opts ...survey.AskOpt) error {
-	return survey.AskOne(p, response, opts...)
-}
+var SurveyAskOne func(survey.Prompt, any, ...survey.AskOpt) error = survey.AskOne
 
 // SurveyAsk ask questions to be stubbed later.
-var SurveyAsk = func(qs []*survey.Question, response any, opts ...survey.AskOpt) error {
-	return survey.Ask(qs, response, opts...)
-}
+var SurveyAsk func([]*survey.Question, any, ...survey.AskOpt) error = survey.Ask

pkg/cli/prompt/prompt.go

@@ -1351,9 +1351,9 @@ func TestMatchPipelinerunAnnotationAndRepositories(t *testing.T) {
 			fakeclient, mux, ghTestServerURL, teardown := ghtesthelper.SetupGH()
 			defer teardown()
 			vcx := &ghprovider.Provider{
-				Client: fakeclient,
-				Token:  github.Ptr("None"),
+				Token: github.Ptr("None"),
 			}
+			vcx.SetGithubClient(fakeclient)
 			if tt.args.runevent.Request == nil {
 				tt.args.runevent.Request = &info.Request{Header: http.Header{}, Payload: nil}
 			}

pkg/matcher/annotation_matcher_test.go

@@ -30,6 +30,12 @@ var runningPRCount = stats.Float64("pipelines_as_code_running_pipelineruns_count
 	"number of running pipelineruns by pipelines as code",
 	stats.UnitDimensionless)
 
+var gitProviderAPIRequestCount = stats.Int64(
+	"pipelines_as_code_git_provider_api_request_count",
+	"number of API requests from pipelines as code to git providers",
+	stats.UnitDimensionless,
+)
+
 // Recorder holds keys for metrics.
 type Recorder struct {
 	initialized     bool
@@ -61,36 +67,42 @@ func NewRecorder() (*Recorder, error) {
 
 		provider, errRegistering := tag.NewKey("provider")
 		if errRegistering != nil {
+			ErrRegistering = errRegistering
 			return
 		}
 		R.provider = provider
 
 		eventType, errRegistering := tag.NewKey("event-type")
 		if errRegistering != nil {
+			ErrRegistering = errRegistering
 			return
 		}
 		R.eventType = eventType
 
 		namespace, errRegistering := tag.NewKey("namespace")
 		if errRegistering != nil {
+			ErrRegistering = errRegistering
 			return
 		}
 		R.namespace = namespace
 
 		repository, errRegistering := tag.NewKey("repository")
 		if errRegistering != nil {
+			ErrRegistering = errRegistering
 			return
 		}
 		R.repository = repository
 
 		status, errRegistering := tag.NewKey("status")
 		if errRegistering != nil {
+			ErrRegistering = errRegistering
 			return
 		}
 		R.status = status
 
 		reason, errRegistering := tag.NewKey("reason")
 		if errRegistering != nil {
+			ErrRegistering = errRegistering
 			return
 		}
 		R.reason = reason
@@ -116,11 +128,18 @@ func NewRecorder() (*Recorder, error) {
 				Aggregation: view.LastValue(),
 				TagKeys:     []tag.Key{R.namespace, R.repository},
 			}
+			gitProviderAPIRequestView = &view.View{
+				Description: gitProviderAPIRequestCount.Description(),
+				Measure:     gitProviderAPIRequestCount,
+				Aggregation: view.Count(),
+				TagKeys:     []tag.Key{R.provider, R.eventType, R.namespace, R.repository},
+			}
 		)
 
-		view.Unregister(prCountView, prDurationView, runningPRView)
-		errRegistering = view.Register(prCountView, prDurationView, runningPRView)
+		view.Unregister(prCountView, prDurationView, runningPRView, gitProviderAPIRequestView)
+		errRegistering = view.Register(prCountView, prDurationView, runningPRView, gitProviderAPIRequestView)
 		if errRegistering != nil {
+			ErrRegistering = errRegistering
 			R.initialized = false
 			return
 		}
@@ -129,12 +148,19 @@ func NewRecorder() (*Recorder, error) {
 	return R, ErrRegistering
 }
 
-// Count logs number of times a pipelinerun is ran for a provider.
-func (r *Recorder) Count(provider, event, namespace, repository string) error {
+func (r Recorder) assertInitialized() error {
 	if !r.initialized {
 		return fmt.Errorf(
 			"ignoring the metrics recording for pipelineruns, failed to initialize the metrics recorder")
 	}
+	return nil
+}
+
+// Count logs number of times a pipelinerun is ran for a provider.
+func (r *Recorder) Count(provider, event, namespace, repository string) error {
+	if err := r.assertInitialized(); err != nil {
+		return err
+	}
 
 	ctx, err := tag.New(
 		context.Background(),
@@ -153,9 +179,8 @@ func (r *Recorder) Count(provider, event, namespace, repository string) error {
 
 // CountPRDuration collects duration taken by a pipelinerun in seconds accumulate them in prDurationCount.
 func (r *Recorder) CountPRDuration(namespace, repository, status, reason string, duration time.Duration) error {
-	if !r.initialized {
-		return fmt.Errorf(
-			"ignoring the metrics recording for pipelineruns, failed to initialize the metrics recorder")
+	if err := r.assertInitialized(); err != nil {
+		return err
 	}
 
 	ctx, err := tag.New(
@@ -175,9 +200,8 @@ func (r *Recorder) CountPRDuration(namespace, repository, status, reason string,
 
 // RunningPipelineRuns emits the number of running PipelineRuns for a repository and namespace.
 func (r *Recorder) RunningPipelineRuns(namespace, repository string, runningPRs float64) error {
-	if !r.initialized {
-		return fmt.Errorf(
-			"ignoring the metrics recording for pipelineruns, failed to initialize the metrics recorder")
+	if err := r.assertInitialized(); err != nil {
+		return err
 	}
 
 	ctx, err := tag.New(
@@ -266,6 +290,26 @@ func (r *Recorder) ReportRunningPipelineRuns(ctx context.Context, lister listers
 	}
 }
 
+func (r *Recorder) ReportGitProviderAPIUsage(provider, event, namespace, repository string) error {
+	if err := r.assertInitialized(); err != nil {
+		return err
+	}
+
+	ctx, err := tag.New(
+		context.Background(),
+		tag.Insert(r.provider, provider),
+		tag.Insert(r.eventType, event),
+		tag.Insert(r.namespace, namespace),
+		tag.Insert(r.repository, repository),
+	)
+	if err != nil {
+		return err
+	}
+
+	metrics.Record(ctx, gitProviderAPIRequestCount.M(1))
+	return nil
+}
+
 func ResetRecorder() {
 	Once = sync.Once{}
 	R = nil

pkg/metrics/metrics.go

@@ -254,10 +254,10 @@ func TestGetPipelineRunsFromRepo(t *testing.T) {
 				ConsoleURL: "https://console.url",
 			}
 			vcx := &ghprovider.Provider{
-				Client: fakeclient,
 				Token:  github.Ptr("None"),
 				Logger: logger,
 			}
+			vcx.SetGithubClient(fakeclient)
 			pacInfo := &info.PacOpts{
 				Settings: settings.Settings{
 					ApplicationName:    "Pipelines as Code CI",

pkg/pipelineascode/match_test.go

@@ -606,11 +606,11 @@ func TestRun(t *testing.T) {
 				},
 			}
 			vcx := &ghprovider.Provider{
-				Client: fakeclient,
 				Run:    cs,
 				Token:  github.Ptr("None"),
 				Logger: logger,
 			}
+			vcx.SetGithubClient(fakeclient)
 			vcx.SetPacInfo(pacInfo)
 			p := NewPacs(&tt.runevent, vcx, cs, pacInfo, k8int, logger, nil)
 			err := p.Run(ctx)

pkg/pipelineascode/pipelineascode_test.go

@@ -27,7 +27,7 @@ func (v *Provider) IsAllowed(ctx context.Context, event *info.Event) (bool, erro
 }
 
 func (v *Provider) isWorkspaceMember(event *info.Event) (bool, error) {
-	members, err := v.Client.Workspaces.Members(event.Organization)
+	members, err := v.Client().Workspaces.Members(event.Organization)
 	if err != nil {
 		return false, err
 	}
@@ -83,7 +83,7 @@ func (v *Provider) checkMember(ctx context.Context, event *info.Event) (bool, er
 }
 
 func (v *Provider) checkOkToTestCommentFromApprovedMember(ctx context.Context, event *info.Event) (bool, error) {
-	commentsIntf, err := v.Client.Repositories.PullRequests.GetComments(&bitbucket.PullRequestsOptions{
+	commentsIntf, err := v.Client().Repositories.PullRequests.GetComments(&bitbucket.PullRequestsOptions{
 		Owner:    event.Organization,
 		RepoSlug: event.Repository,
 		ID:       strconv.Itoa(event.PullRequestNumber),