Added example

Co-authored-by: kjuulh <contact@kjuulh.io>
Reviewed-on: https://git.front.kjuulh.io/kjuulh/kraken/pulls/11

.releaserc.yml

@@ -1,11 +0,0 @@
-
-  branches: 
-  - "main"
-  - "v0.x"
-
-  plugins:
-  - "@semantic-release/commit-analyzer"
-  - "@semantic-release/release-notes-generator"
-  - "@semantic-release/changelog"
-  - "@semantic-release/git"
-  

cmd/kraken/commands/process.go

@@ -9,19 +9,9 @@ import (
 )
 
 func CreateKrakenProcessCmd() *cobra.Command {
-
-	var (
-		actionsRepo string
-		branch      string
-		path        string
-	)
 	cmd := &cobra.Command{
 		Use: "process",
-		RunE: func(cmd *cobra.Command, args []string) error {
-			if err := cmd.ParseFlags(args); err != nil {
-				return err
-			}
-
+		Run: func(cmd *cobra.Command, _ []string) {
 			client := http.Client{}
 
 			var buf bytes.Buffer
@@ -31,9 +21,9 @@ func CreateKrakenProcessCmd() *cobra.Command {
 					Branch     string `json:"branch"`
 					Path       string `json:"path"`
 				}{
-					Repository: actionsRepo,
-					Branch:     branch,
-					Path:       path,
+					Repository: "git@git.front.kjuulh.io:kjuulh/kraken.git",
+					Branch:     "feature/docker-action",
+					Path:       "_examples/actions/docker_action/",
 				})
 			if err != nil {
 				panic(err)
@@ -56,18 +46,8 @@ func CreateKrakenProcessCmd() *cobra.Command {
 			if resp.StatusCode >= 300 {
 				panic(resp.Status)
 			}
-
-			return nil
 		},
 	}
 
-	pf := cmd.PersistentFlags()
-
-	pf.StringVar(&actionsRepo, "actions-repo", "", "actions repo is the location of your actions, not where to apply the actions themselves, that should be self contained")
-	cmd.MarkPersistentFlagRequired("actions-repo")
-	pf.StringVar(&branch, "branch", "main", "which branch to look for actions in, will default to main")
-	pf.StringVar(&path, "path", "", "the location of the path inside the repository")
-	cmd.MarkPersistentFlagRequired("path")
-
 	return cmd
 }

internal/actions/action.go

@@ -5,7 +5,6 @@ import (
 	"errors"
 
 	"git.front.kjuulh.io/kjuulh/kraken/internal/actions/builders"
-	"git.front.kjuulh.io/kjuulh/kraken/internal/actions/querier"
 	"git.front.kjuulh.io/kjuulh/kraken/internal/schema"
 	"git.front.kjuulh.io/kjuulh/kraken/internal/services/storage"
 	"go.uber.org/zap"
@@ -50,28 +49,3 @@ func (a *Action) Execute(ctx context.Context, area *storage.Area) error {
 
 	return nil
 }
-
-func (a *Action) Query(ctx context.Context, area *storage.Area) ([]string, bool, error) {
-	for _, query := range a.Schema.Queries {
-		switch query.Type {
-		case "grep":
-			exe, err := querier.NewRipGrep(zap.L()).Build(ctx, a.SchemaPath, query.Query)
-			if err != nil {
-				return nil, false, err
-			}
-			output, found, err := exe(ctx, area.Path)
-			if err != nil {
-				return nil, false, err
-			}
-
-			zap.L().Debug("Execution done")
-
-			return output, found, nil
-
-		default:
-			return nil, false, errors.New("could not determine query type")
-		}
-	}
-
-	return nil, false, nil
-}

internal/actions/querier/ripgrep.go

@@ -1,106 +0,0 @@
-package querier
-
-import (
-	"context"
-	"fmt"
-	"io"
-	"os/exec"
-	"strings"
-
-	"go.uber.org/zap"
-	"go.uber.org/zap/zapio"
-)
-
-type RipGrep struct {
-	logger *zap.Logger
-}
-
-func NewRipGrep(logger *zap.Logger) *RipGrep {
-	return &RipGrep{logger: logger}
-}
-
-type RipGrepCommand func(ctx context.Context, victimPath string) ([]string, bool, error)
-
-func (g *RipGrep) Build(ctx context.Context, modulePath, query string) (RipGrepCommand, error) {
-	g.logger.Debug("Pulling docker image", zap.String("actiondir", modulePath), zap.String("query", query))
-
-	pullDockerImage := "docker pull mbologna/docker-ripgrep"
-	g.logger.Debug("Running command", zap.String("command", pullDockerImage))
-
-	cmd := exec.CommandContext(
-		ctx,
-		"/bin/bash",
-		"-c",
-		pullDockerImage,
-	)
-
-	debugwriter := &zapio.Writer{
-		Log:   g.logger,
-		Level: zap.DebugLevel,
-	}
-	defer debugwriter.Close()
-
-	cmd.Stdout = debugwriter
-	cmd.Stderr = debugwriter
-	err := cmd.Start()
-	if err != nil {
-		return nil, err
-	}
-
-	err = cmd.Wait()
-	if err != nil {
-		return nil, err
-	}
-
-	g.logger.Debug("Docker image pulled")
-
-	return func(ctx context.Context, victimPath string) ([]string, bool, error) {
-		g.logger.Debug("Executing script", zap.String("victim", victimPath))
-
-		runRipGrepCmd := fmt.Sprintf("docker run --rm -v %s/:/data:ro mbologna/docker-ripgrep rg -i '%s' || true", victimPath, query)
-
-		g.logger.Debug("Execute ripgrep query", zap.String("command", runRipGrepCmd))
-
-		cmd := exec.CommandContext(
-			ctx,
-			"/bin/bash",
-			"-c",
-			runRipGrepCmd,
-		)
-
-		runDockerWriter := &zapio.Writer{
-			Log:   g.logger,
-			Level: zap.DebugLevel,
-		}
-		defer runDockerWriter.Close()
-
-		builder := &strings.Builder{}
-		combinedWriter := io.MultiWriter(runDockerWriter, builder)
-
-		cmd.Stdout = combinedWriter
-		cmd.Stderr = combinedWriter
-
-		err = cmd.Start()
-		if err != nil {
-			return nil, false, err
-		}
-
-		err = cmd.Wait()
-		if err != nil {
-			return nil, false, err
-		}
-
-		contents := strings.Split(builder.String(), "\n")
-		validatedOutput := make([]string, 0)
-
-		for _, c := range contents {
-			if !strings.Contains(c, "WARNING:") {
-				validatedOutput = append(validatedOutput, c)
-			}
-		}
-
-		found := len(validatedOutput) > 0
-
-		return validatedOutput, found, nil
-	}, nil
-}

internal/commands/process_repos.go

@@ -112,32 +112,17 @@ func (pr *ProcessRepos) processRepo(ctx context.Context, repoUrl string, action
 		return err
 	}
 
-	if len(action.Schema.Queries) > 0 {
-		result, found, err := action.Query(ctx, area)
-		if err != nil {
-			return err
-		}
-
-		if found {
-			pr.logger.Info("Query result", zap.Strings("result", result))
-			// TODO: Append to real result, and return together
-		}
+	err = action.Execute(ctx, area)
+	if err != nil {
+		return err
 	}
 
-	if len(action.Schema.Actions) > 0 {
-		err = action.Execute(ctx, area)
-		if err != nil {
-			return err
-		}
-
-		err = pr.commit(ctx, area, repo, repoUrl)
-		if err != nil {
-			return err
-		}
+	err = pr.commit(ctx, area, repo, repoUrl)
+	if err != nil {
+		return err
 	}
 
 	pr.logger.Debug("processing done", zap.String("path", area.Path), zap.String("repoUrl", repoUrl))
-
 	return nil
 }
 

internal/schema/kraken.go

@@ -16,10 +16,6 @@ type KrakenSchema struct {
 		Type  string `yaml:"type"`
 		Entry string `yaml:"entry"`
 	} `yaml:"actions"`
-	Queries []struct {
-		Type  string `yaml:"type"`
-		Query string `yaml:"query"`
-	} `yaml:"queries"`
 }
 
 func Unmarshal(raw string) (*KrakenSchema, error) {

internal/services/providers/git.go

@@ -242,7 +242,7 @@ func (g *Git) CreateBranch(ctx context.Context, gitRepo *GitRepo) error {
 	err = worktree.PullContext(ctx, &git.PullOptions{
 		RemoteName:        "origin",
 		ReferenceName:     "refs/heads/main",
-		SingleBranch:      false,
+		SingleBranch:      true,
 		Depth:             1,
 		Auth:              auth,
 		RecurseSubmodules: 1,

roadmap.md

@@ -22,7 +22,7 @@
 - [x] Allow instantiation of actions, kraken template repo etc.
 - [x] Implement docker action
 - [x] Create pr for gitea provider
-- [x] Providing query results
+- [ ] Providing query results
 - [ ] Create CLI to trigger action
 
 ### Not in scope
@@ -34,9 +34,6 @@
 - [ ] Make configurable gpg keyset
 - [ ] Make configurable git provider
 - [ ] Create templating function
-- [ ] Add way to see progress of runners
-- [ ] Implement global .kraken store for easy access
-- [ ] Move builders to start instead of every time
 
 ## Version 1.x
 

scripts/run_client.sh

@@ -2,7 +2,4 @@
 
 set -e
 
-current_branch=$(git branch --show-current)
-
-go run cmd/kraken/kraken.go process --actions-repo "git@git.front.kjuulh.io:kjuulh/kraken.git" --branch "$current_branch" --path "_examples/actions/write_a_readme"
-go run cmd/kraken/kraken.go process --actions-repo "git@git.front.kjuulh.io:kjuulh/kraken.git" --branch "$current_branch" --path "_examples/queries/scrape_readme"
+go run cmd/kraken/kraken.go process