feat: initial github support

Author: jippi

.github/workflows/test.yml

@@ -46,11 +46,11 @@ jobs:
       - name: Ensure scm-engine binary work
         run: ./scm-engine -h
 
-      - name: Test scm-engine against test GitLab project
+      - name: Test scm-engine against a GitLab project
         run: ./scm-engine evaluate all
         env:
           SCM_ENGINE_TOKEN: "${{ secrets.GITLAB_INTEGRATION_TEST_API_TOKEN }}"
-          SCM_ENGINE_CONFIG_FILE: ".scm-engine.example.yml"
+          SCM_ENGINE_CONFIG_FILE: ".scm-engine.gitlab.example.yml"
           GITLAB_PROJECT: "jippi/scm-engine-schema-test"
           GITLAB_BASEURL: https://gitlab.com/
 

.gitignore

@@ -17,3 +17,4 @@
 /scm-engine
 /scm-engine.exe
 /docs/gitlab/script-attributes.md
+/docs/github/script-attributes.md

.scm-engine.example.yml .scm-engine.gitlab.example.yml

@@ -5,23 +5,26 @@ import (
 
 	"github.com/jippi/scm-engine/pkg/config"
 	"github.com/jippi/scm-engine/pkg/scm"
-	"github.com/jippi/scm-engine/pkg/scm/gitlab"
 	"github.com/jippi/scm-engine/pkg/state"
 	"github.com/urfave/cli/v2"
 )
 
 func Evaluate(cCtx *cli.Context) error {
 	ctx := state.WithProjectID(cCtx.Context, cCtx.String(FlagSCMProject))
+	ctx = state.WithBaseURL(ctx, cCtx.String(FlagSCMBaseURL))
 	ctx = state.WithCommitSHA(ctx, cCtx.String(FlagCommitSHA))
 	ctx = state.WithDryRun(ctx, cCtx.Bool(FlagDryRun))
+	ctx = state.WithProvider(ctx, cCtx.String(FlagProvider))
+	ctx = state.WithToken(ctx, cCtx.String(FlagAPIToken))
+	ctx = state.WithToken(ctx, cCtx.String(FlagAPIToken))
 	ctx = state.WithUpdatePipeline(ctx, cCtx.Bool(FlagUpdatePipeline))
 
 	cfg, err := config.LoadFile(cCtx.String(FlagConfigFile))
 	if err != nil {
 		return err
 	}
 
-	client, err := gitlab.NewClient(cCtx.String(FlagAPIToken), cCtx.String(FlagSCMBaseURL))
+	client, err := getClient(ctx)
 	if err != nil {
 		return err
 	}

cmd/cmd_evaluate.go

@@ -14,7 +14,6 @@ import (
 	"time"
 
 	"github.com/jippi/scm-engine/pkg/config"
-	"github.com/jippi/scm-engine/pkg/scm/gitlab"
 	"github.com/jippi/scm-engine/pkg/state"
 	"github.com/urfave/cli/v2"
 	slogctx "github.com/veqryn/slog-context"
@@ -55,15 +54,22 @@ func errHandler(ctx context.Context, w http.ResponseWriter, code int, err error)
 	return
 }
 
-func Server(cCtx *cli.Context) error { //nolint:unparam
-	slogctx.Info(cCtx.Context, "Starting HTTP server", slog.String("listen", cCtx.String(FlagServerListen)))
+func Server(cCtx *cli.Context) error {
+	// Initialize context
+	ctx := state.WithDryRun(cCtx.Context, cCtx.Bool(FlagDryRun))
+	ctx = state.WithBaseURL(ctx, cCtx.String(FlagSCMBaseURL))
+	ctx = state.WithToken(ctx, cCtx.String(FlagAPIToken))
+	ctx = state.WithProvider(ctx, cCtx.String(FlagProvider))
+	ctx = state.WithUpdatePipeline(ctx, cCtx.Bool(FlagUpdatePipeline))
+
+	slogctx.Info(ctx, "Starting HTTP server", slog.String("listen", cCtx.String(FlagServerListen)))
 
 	mux := http.NewServeMux()
 
 	ourSecret := cCtx.String(FlagWebhookSecret)
 
-	// Initialize GitLab client
-	client, err := gitlab.NewClient(cCtx.String(FlagAPIToken), cCtx.String(FlagSCMBaseURL))
+	// Initialize client
+	client, err := getClient(cCtx.Context)
 	if err != nil {
 		return err
 	}
@@ -179,9 +185,6 @@ func Server(cCtx *cli.Context) error { //nolint:unparam
 		ReadTimeout:  5 * time.Second,
 		WriteTimeout: 5 * time.Second,
 		BaseContext: func(l net.Listener) context.Context {
-			ctx := state.WithDryRun(cCtx.Context, cCtx.Bool(FlagDryRun))
-			ctx = state.WithUpdatePipeline(ctx, cCtx.Bool(FlagUpdatePipeline))
-
 			return ctx
 		},
 	}

cmd/cmd_server.go

@@ -2,13 +2,14 @@ package cmd
 
 const (
 	FlagAPIToken       = "api-token"
+	FlagCommitSHA      = "commit"
 	FlagConfigFile     = "config"
 	FlagDryRun         = "dry-run"
 	FlagMergeRequestID = "id"
-	FlagUpdatePipeline = "update-pipeline"
-	FlagCommitSHA      = "commit"
+	FlagProvider       = "provider"
 	FlagSCMBaseURL     = "base-url"
 	FlagSCMProject     = "project"
 	FlagServerListen   = "listen"
+	FlagUpdatePipeline = "update-pipeline"
 	FlagWebhookSecret  = "webhook-secret"
 )

cmd/conventions.go

@@ -8,14 +8,29 @@ import (
 
 	"github.com/jippi/scm-engine/pkg/config"
 	"github.com/jippi/scm-engine/pkg/scm"
+	"github.com/jippi/scm-engine/pkg/scm/github"
+	"github.com/jippi/scm-engine/pkg/scm/gitlab"
 	"github.com/jippi/scm-engine/pkg/state"
 	slogctx "github.com/veqryn/slog-context"
 )
 
+func getClient(ctx context.Context) (scm.Client, error) {
+	switch state.Provider(ctx) {
+	case "github":
+		return github.NewClient(ctx), nil
+
+	case "gitlab":
+		return gitlab.NewClient(ctx)
+
+	default:
+		return nil, fmt.Errorf("unknown provider %q - we only support 'github' and 'gitlab'", state.Provider(ctx))
+	}
+}
+
 func ProcessMR(ctx context.Context, client scm.Client, cfg *config.Config, event any) (err error) {
 	// Stop the pipeline when we leave this func
 	defer func() {
-		if stopErr := client.Stop(ctx, err); err != nil {
+		if stopErr := client.Stop(ctx, err); stopErr != nil {
 			slogctx.Error(ctx, "Failed to update pipeline", slog.Any("error", stopErr))
 		}
 	}()
@@ -157,12 +172,12 @@ func syncLabels(ctx context.Context, client scm.Client, remote []*scm.Label, req
 
 	// Update
 	for _, label := range required {
-		e, ok := remoteLabels[label.Name]
+		remote, ok := remoteLabels[label.Name]
 		if !ok {
 			continue
 		}
 
-		if label.IsEqual(e) {
+		if label.IsEqual(ctx, remote) {
 			continue
 		}
 

cmd/shared.go

@@ -0,0 +1,3 @@
+# Setup
+
+TODO

docs/github/setup.md

@@ -9,6 +9,7 @@ require (
 	github.com/expr-lang/expr v1.16.7
 	github.com/fatih/structtag v1.2.0
 	github.com/golang-cz/devslog v0.0.8
+	github.com/google/go-github/v62 v62.0.0
 	github.com/guregu/null/v5 v5.0.0
 	github.com/hasura/go-graphql-client v0.12.1
 	github.com/iancoleman/strcase v0.3.0

go.mod

@@ -26,8 +26,10 @@ github.com/go-logr/logr v1.4.1/go.mod h1:9T104GzyrTigFIr8wt5mBrctHMim0Nb2HLGrmQ4
 github.com/golang-cz/devslog v0.0.8 h1:53ipA2rC5JzWBWr9qB8EfenvXppenNiF/8DwgtNT5Q4=
 github.com/golang-cz/devslog v0.0.8/go.mod h1:bSe5bm0A7Nyfqtijf1OMNgVJHlWEuVSXnkuASiE1vV8=
 github.com/google/go-cmp v0.5.2/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
-github.com/google/go-cmp v0.5.9 h1:O2Tfq5qg4qc4AmwVlvv0oLiVAGB7enBSJ2x2DqQFi38=
-github.com/google/go-cmp v0.5.9/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY=
+github.com/google/go-cmp v0.6.0 h1:ofyhxvXcZhMsU5ulbFiLKl/XBFqE1GSq7atu8tAmTRI=
+github.com/google/go-cmp v0.6.0/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY=
+github.com/google/go-github/v62 v62.0.0 h1:/6mGCaRywZz9MuHyw9gD1CwsbmBX8GWsbFkwMmHdhl4=
+github.com/google/go-github/v62 v62.0.0/go.mod h1:EMxeUqGJq2xRu9DYBMwel/mr7kZrzUOfQmmpYrZn2a4=
 github.com/google/go-querystring v1.1.0 h1:AnCroh3fv4ZBgVIf1Iwtovgjaw/GiKJo8M8yD/fhyJ8=
 github.com/google/go-querystring v1.1.0/go.mod h1:Kcdr2DB4koayq7X8pmAG4sNG59So17icRSOU623lUBU=
 github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=

go.sum

@@ -52,6 +52,14 @@ func main() {
 					"SCM_ENGINE_CONFIG_FILE",
 				},
 			},
+			&cli.StringFlag{
+				Name:  cmd.FlagProvider,
+				Usage: "Provider to use - can be 'github' or 'gitlab'",
+				Value: "gitlab",
+				EnvVars: []string{
+					"SCM_ENGINE_PROVIDER",
+				},
+			},
 			&cli.StringFlag{
 				Name:     cmd.FlagAPIToken,
 				Usage:    "GitHub/GitLab API token",

main.go

@@ -13,6 +13,7 @@ nav:
   - install.md
   - ... | configuration/*.md
   - ... | commands/*.md
+  - ... | github/*.md
   - ... | gitlab/*.md
 
 plugins:

mkdocs.yml

@@ -0,0 +1,65 @@
+package github
+
+import (
+	"context"
+
+	go_github "github.com/google/go-github/v62/github"
+	"github.com/jippi/scm-engine/pkg/scm"
+	"github.com/jippi/scm-engine/pkg/state"
+)
+
+// Ensure the GitLab client implements the [scm.Client]
+var _ scm.Client = (*Client)(nil)
+
+// Client is a wrapper around the GitLab specific implementation of [scm.Client] interface
+type Client struct {
+	wrapped *go_github.Client
+
+	labels        *LabelClient
+	mergeRequests *MergeRequestClient
+}
+
+// NewClient creates a new GitLab client
+func NewClient(ctx context.Context) *Client {
+	client := go_github.NewClient(nil).WithAuthToken(state.Token(ctx))
+
+	return &Client{wrapped: client}
+}
+
+// Labels returns a client target at managing labels/tags
+func (client *Client) Labels() scm.LabelClient {
+	if client.labels == nil {
+		client.labels = NewLabelClient(client)
+	}
+
+	return client.labels
+}
+
+// MergeRequests returns a client target at managing merge/pull requests
+func (client *Client) MergeRequests() scm.MergeRequestClient {
+	if client.mergeRequests == nil {
+		client.mergeRequests = NewMergeRequestClient(client)
+	}
+
+	return client.mergeRequests
+}
+
+// EvalContext creates a new evaluation context for GitLab specific usage
+func (client *Client) EvalContext(ctx context.Context) (scm.EvalContext, error) {
+	res, err := NewContext(ctx, "https://api.github.com/", state.Token(ctx))
+	if err != nil {
+		return nil, err
+	}
+
+	return res, nil
+}
+
+// Start pipeline
+func (client *Client) Start(ctx context.Context) error {
+	return nil
+}
+
+// Stop pipeline
+func (client *Client) Stop(ctx context.Context, err error) error {
+	return nil
+}