Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Post health status comment #407

Merged
merged 2 commits into from
Sep 12, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions PROJECT
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,9 @@ resources:
group: argocdcommenter
kind: ApplicationSyncStatus
version: v1
- controller: true
domain: int128.github.io
group: argocdcommenter
kind: ApplicationHealthStatus
version: v1
version: "3"
20 changes: 20 additions & 0 deletions controllers/annotation.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
package controllers

import (
"context"

argocdv1alpha1 "github.com/argoproj/argo-cd/v2/pkg/apis/application/v1alpha1"
"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
"sigs.k8s.io/controller-runtime/pkg/client"
)

func patchAnnotation(ctx context.Context, c client.Client, a argocdv1alpha1.Application, f func(map[string]string)) error {
var patch unstructured.Unstructured
patch.SetGroupVersionKind(a.GroupVersionKind())
patch.SetNamespace(a.Namespace)
patch.SetName(a.Name)
annotations := a.DeepCopy().Annotations
f(annotations)
patch.SetAnnotations(annotations)
return c.Patch(ctx, &patch, client.Apply, &client.PatchOptions{FieldManager: "argocd-commenter"})
}
140 changes: 140 additions & 0 deletions controllers/applicationhealthstatus_controller.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,140 @@
/*
Copyright 2021.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

package controllers

import (
"context"
"fmt"

argocdv1alpha1 "github.com/argoproj/argo-cd/v2/pkg/apis/application/v1alpha1"
"github.com/argoproj/gitops-engine/pkg/health"
"github.com/int128/argocd-commenter/pkg/github"
"k8s.io/apimachinery/pkg/runtime"
ctrl "sigs.k8s.io/controller-runtime"
"sigs.k8s.io/controller-runtime/pkg/client"
"sigs.k8s.io/controller-runtime/pkg/event"
"sigs.k8s.io/controller-runtime/pkg/log"
)

const (
lastRevisionHealthy = "argocd-commenter.int128.github.io/last-revision-healthy"
)

// ApplicationHealthStatusReconciler reconciles a ApplicationHealthStatus object
type ApplicationHealthStatusReconciler struct {
client.Client
Scheme *runtime.Scheme
GitHubClient github.Client
}

//+kubebuilder:rbac:groups=argoproj.io,resources=applications,verbs=get;watch;list

func (r *ApplicationHealthStatusReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error) {
logger := log.FromContext(ctx)

var application argocdv1alpha1.Application
if err := r.Get(ctx, req.NamespacedName, &application); err != nil {
logger.Error(err, "unable to get the Application")
return ctrl.Result{}, client.IgnoreNotFound(err)
}

lastRevision, ok := application.Annotations[lastRevisionHealthy]
if ok {
if lastRevision == application.Status.Sync.Revision {
logger.Info("already added a comment", "revision", lastRevision)
return ctrl.Result{}, nil
}
}
err := patchAnnotation(ctx, r.Client, application, func(annotations map[string]string) {
annotations[lastRevisionHealthy] = application.Status.Sync.Revision
})
if err != nil {
logger.Error(err, "unable to patch annotations to the Application")
return ctrl.Result{}, err
}

repository, err := github.ParseRepositoryURL(application.Spec.Source.RepoURL)
if err != nil {
logger.Error(err, "skip non-GitHub URL", "url", application.Spec.Source.RepoURL)
return ctrl.Result{}, nil
}
comment := github.Comment{
Repository: *repository,
CommitSHA: application.Status.Sync.Revision,
Body: healthStatusCommentFor(application),
}
logger.Info("adding a comment", "health", application.Status.Health.Status, "comment", comment)
if err := r.GitHubClient.AddComment(ctx, comment); err != nil {
logger.Error(err, "unable to add a comment", "comment", comment)
return ctrl.Result{}, nil
}
return ctrl.Result{}, nil
}

func healthStatusCommentFor(a argocdv1alpha1.Application) string {
if a.Status.Health.Status == health.HealthStatusHealthy {
return fmt.Sprintf(":white_check_mark: %s: %s",
a.Status.Health.Status,
a.Name)
}
return fmt.Sprintf(":warning: %s: %s",
a.Status.Sync.Status,
a.Name)
}

// SetupWithManager sets up the controller with the Manager.
func (r *ApplicationHealthStatusReconciler) SetupWithManager(mgr ctrl.Manager) error {
return ctrl.NewControllerManagedBy(mgr).
For(&argocdv1alpha1.Application{}).
WithEventFilter(&applicationHealthStatusChangePredicate{}).
Complete(r)
}

type applicationHealthStatusChangePredicate struct{}

func (p applicationHealthStatusChangePredicate) Create(event.CreateEvent) bool {
return false
}

func (p applicationHealthStatusChangePredicate) Delete(event.DeleteEvent) bool {
return false
}

func (p applicationHealthStatusChangePredicate) Update(e event.UpdateEvent) bool {
applicationOld, ok := e.ObjectOld.(*argocdv1alpha1.Application)
if !ok {
return false
}
applicationNew, ok := e.ObjectNew.(*argocdv1alpha1.Application)
if !ok {
return false
}
if applicationOld.Status.Health.Status == applicationNew.Status.Health.Status {
return false
}

// notify only the following statuses
switch applicationNew.Status.Health.Status {
case health.HealthStatusHealthy, health.HealthStatusDegraded:
return true
}
return false
}

func (p applicationHealthStatusChangePredicate) Generic(event.GenericEvent) bool {
return false
}
9 changes: 9 additions & 0 deletions main.go
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ import (
"os"

argocdv1alpha1 "github.com/argoproj/argo-cd/v2/pkg/apis/application/v1alpha1"

"github.com/int128/argocd-commenter/pkg/github"

// Import all Kubernetes client auth plugins (e.g. Azure, GCP, OIDC, etc.)
Expand Down Expand Up @@ -105,6 +106,14 @@ func main() {
setupLog.Error(err, "unable to create controller", "controller", "ApplicationSyncStatus")
os.Exit(1)
}
if err = (&controllers.ApplicationHealthStatusReconciler{
Client: mgr.GetClient(),
Scheme: mgr.GetScheme(),
GitHubClient: githubClient,
}).SetupWithManager(mgr); err != nil {
setupLog.Error(err, "unable to create controller", "controller", "ApplicationHealthStatus")
os.Exit(1)
}
//+kubebuilder:scaffold:builder

if err := mgr.AddHealthzCheck("healthz", healthz.Ping); err != nil {
Expand Down