-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: Added Smart Mode that Automatically detects changed Environment… (
#62) …s and Applications --------- Co-authored-by: Fritz Durchardt <fritz.duchardt.ext@gec.io>
- Loading branch information
1 parent
06e5e5c
commit e404b6b
Showing
15 changed files
with
1,208 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| # Smart Mode | ||
|
|
||
| Smart Mode looks at the changes you made and figures out which environments and applications need re-rendering. | ||
|
|
||
| It is activated by default. | ||
|
|
||
| ## How it works | ||
|
|
||
| ### No changes relative to rendering | ||
|
|
||
| If you make changes that have no impact on the rendered output of your workloads, e.g. modify `Dockerfile`, myks | ||
| will exit immediately, before any syncing or rendering happens. | ||
|
|
||
| ### Re-rendering of an application | ||
|
|
||
| An application of a specific environment get re-rendered when: | ||
| - The `app-data.ytt.yaml` of that application has changed, e.g. `envs/env-1/_apps/app-1/app-data.ytt.yaml` | ||
| - The prototype application has changed, e.g. `prototypes/app-1/helm/app-1.yaml`, in which case all environments that use is re-render that application. | ||
|
|
||
| ### Re-rendering of an environment | ||
|
|
||
| All applications of an environment get re-rendered when: | ||
| - The `env-data.ytt.yaml` of that environment has changed. | ||
| - The `env-data.ytt.yaml` of a parent environment of that environment has changed. | ||
| - **Edge case:** If you have made changes to an application in env-1, but at the same time have modified the `env-data.ytt.yaml` of env-2, smart-mode will re-render all applications of env-1 AND env-2, even though this is not strictly required for env-1. | ||
|
|
||
| ### Complete rendering | ||
|
|
||
| A complete rendering of all environments and all applications is required when: | ||
| - A file in the common lib has changed, e.g. `/lib/common.lib.star` | ||
| - A file in the global ytt folder has changed, e.g. `/envs/_env/ytt/annotate_crds.yaml` | ||
| - The base `env-data.ytt.yaml` has changed: `/envs/env-data.ytt.yaml` | ||
|
|
||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,112 @@ | ||
| package myks | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "os" | ||
| "strings" | ||
|
|
||
| "github.com/rs/zerolog/log" | ||
| ) | ||
|
|
||
| type ChangedFile struct { | ||
| path string | ||
| status string | ||
| } | ||
|
|
||
| // return all files paths that were changed since the revision | ||
| func getChangedFiles(revision string) ([]ChangedFile, error) { | ||
| log := func(name string, args []string) { | ||
| log.Debug().Msg(msgRunCmd("get diff for smart-mode", name, args)) | ||
| } | ||
| _, err := runCmd("git", nil, []string{"add", ".", "--intent-to-add"}, log) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| result, err := runCmd("git", nil, []string{"diff", "--ignore-blank-lines", "--name-status", revision}, log) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| if result.Stdout == "" { | ||
| return nil, nil | ||
| } | ||
| return convertToChangedFiles(result.Stdout), err | ||
| } | ||
|
|
||
| func convertToChangedFiles(changes string) []ChangedFile { | ||
| var cfs []ChangedFile | ||
| for _, str := range strings.Split(changes, "\n") { | ||
| if str != "" { | ||
| parts := strings.Split(str, "\t") | ||
| cf := ChangedFile{path: parts[1], status: parts[0]} | ||
| cfs = append(cfs, cf) | ||
| } | ||
| } | ||
| return cfs | ||
| } | ||
|
|
||
| func extractChangedFilePaths(cfs []ChangedFile) []string { | ||
| var paths []string | ||
| for _, cf := range cfs { | ||
| paths = append(paths, cf.path) | ||
| } | ||
| return paths | ||
| } | ||
|
|
||
| func extractChangedFilePathsWithStatus(cfs []ChangedFile, status string) []string { | ||
| filter := func(cf ChangedFile) bool { | ||
| if status == "" || cf.status == status { | ||
| return true | ||
| } | ||
| return false | ||
| } | ||
| return extractChangedFilePaths(extract(cfs, filter)) | ||
| } | ||
|
|
||
| func extractChangedFilePathsWithoutStatus(cfs []ChangedFile, status string) []string { | ||
| filter := func(cf ChangedFile) bool { | ||
| if status == "" || cf.status != status { | ||
| return true | ||
| } | ||
| return false | ||
| } | ||
| return extractChangedFilePaths(extract(cfs, filter)) | ||
| } | ||
|
|
||
| // get head revision of main branch | ||
| func getMainBranchHeadRevision(mainBranch string) (string, error) { | ||
| log := func(name string, args []string) { | ||
| log.Debug().Msg(msgRunCmd("get main branch head revision for smart-mode", name, args)) | ||
| } | ||
| _, err := runCmd("git", nil, []string{"fetch", "origin", mainBranch}, log) | ||
| if err != nil { | ||
| return "", err | ||
| } | ||
| cmdResult, err := runCmd("git", nil, []string{"merge-base", "origin/" + mainBranch, "HEAD"}, log) | ||
| if err != nil { | ||
| return "", err | ||
| } | ||
| // git adds new line to output which messes up the result | ||
| headRevision := strings.TrimRight(cmdResult.Stdout, "\n") | ||
| return headRevision, nil | ||
| } | ||
|
|
||
| // get head revision | ||
| func getCurrentBranchHeadRevision() (string, error) { | ||
| log := func(name string, args []string) { | ||
| log.Debug().Msg(msgRunCmd("get current head revision for smart-mode", name, args)) | ||
| } | ||
| cmdResult, err := runCmd("git", nil, []string{"rev-parse", "HEAD"}, log) | ||
| if err != nil { | ||
| return "", fmt.Errorf("failed to get current branch head revision: %v", err) | ||
| } | ||
| return strings.TrimRight(cmdResult.Stdout, "\n"), nil | ||
| } | ||
|
|
||
| func getDiffRevision(mainBranch string) (string, error) { | ||
| if os.Getenv("CI") != "" { | ||
| log.Debug().Msg("Pipeline mode: comparing with HEAD revision on main") | ||
| return getMainBranchHeadRevision(mainBranch) | ||
| } | ||
| log.Debug().Msg("Local mode: comparing with HEAD revision on current branch") | ||
| return getCurrentBranchHeadRevision() | ||
| } |
Oops, something went wrong.