Skip to content

Commit

Permalink
chore: rename to include global prefix
Browse files Browse the repository at this point in the history
  • Loading branch information
@thisislawatts
thisislawatts committed Apr 12, 2024
1 parent f64fa66 commit b19ae31
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 32 deletions.
37 changes: 18 additions & 19 deletions cliv2/cmd/cliv2/main.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ package main
// !!! This import needs to be the first import, please do not change this !!!
import _ "github.com/snyk/go-application-framework/pkg/networking/fips_enable"


import (
"context"
"encoding/json"
Expand Down Expand Up @@ -43,7 +42,7 @@ import (
)

var internalOS string
var engine workflow.Engine
var globalEngine workflow.Engine
var globalConfiguration configuration.Configuration
var helpProvided bool

Expand Down Expand Up @@ -157,9 +156,9 @@ func runMainWorkflow(config configuration.Configuration, cmd *cobra.Command, arg
name := getFullCommandString(cmd)
globalLogger.Print("Running ", name)
// TODO: Rename as globalEngine
engine.GetAnalytics().SetCommand(name)
globalEngine.GetAnalytics().SetCommand(name)

err = runWorkflowAndProcessData(engine, globalLogger, name)
err = runWorkflowAndProcessData(globalEngine, globalLogger, name)

return err
}
Expand Down Expand Up @@ -257,7 +256,7 @@ func defaultCmd(args []string) error {
// * by specifying the raw cmd args for it
globalConfiguration.Set(configuration.WORKFLOW_USE_STDIO, true)
globalConfiguration.Set(configuration.RAW_CMD_ARGS, args)
_, err := engine.Invoke(basic_workflows.WORKFLOWID_LEGACY_CLI)
_, err := globalEngine.Invoke(basic_workflows.WORKFLOWID_LEGACY_CLI)
return err
}

Expand Down Expand Up @@ -423,39 +422,39 @@ func MainWithErrorCode() int {
debugEnabled := globalConfiguration.GetBool(configuration.DEBUG)
globalLogger = initDebugLogger(globalConfiguration)

engine = app.CreateAppEngineWithOptions(app.WithZeroLogger(globalLogger), app.WithConfiguration(globalConfiguration), app.WithRuntimeInfo(rInfo))
globalEngine = app.CreateAppEngineWithOptions(app.WithZeroLogger(globalLogger), app.WithConfiguration(globalConfiguration), app.WithRuntimeInfo(rInfo))

if noProxyAuth := globalConfiguration.GetBool(basic_workflows.PROXY_NOAUTH); noProxyAuth {
globalConfiguration.Set(configuration.PROXY_AUTHENTICATION_MECHANISM, httpauth.StringFromAuthenticationMechanism(httpauth.NoAuth))
}

// initialize the extensions -> they register themselves at the engine
engine.AddExtensionInitializer(basic_workflows.Init)
engine.AddExtensionInitializer(sbom.Init)
engine.AddExtensionInitializer(depgraph.Init)
engine.AddExtensionInitializer(capture.Init)
engine.AddExtensionInitializer(iacrules.Init)
engine.AddExtensionInitializer(snykls.Init)
engine.AddExtensionInitializer(container.Init)
engine.AddExtensionInitializer(localworkflows.InitCodeWorkflow)
globalEngine.AddExtensionInitializer(basic_workflows.Init)
globalEngine.AddExtensionInitializer(sbom.Init)
globalEngine.AddExtensionInitializer(depgraph.Init)
globalEngine.AddExtensionInitializer(capture.Init)
globalEngine.AddExtensionInitializer(iacrules.Init)
globalEngine.AddExtensionInitializer(snykls.Init)
globalEngine.AddExtensionInitializer(container.Init)
globalEngine.AddExtensionInitializer(localworkflows.InitCodeWorkflow)

// init engine
err = engine.Init()
err = globalEngine.Init()
if err != nil {
globalLogger.Print("Failed to init Workflow Engine!", err)
return constants.SNYK_EXIT_CODE_ERROR
}

// add output flags as persistent flags
outputWorkflow, _ := engine.GetWorkflow(localworkflows.WORKFLOWID_OUTPUT_WORKFLOW)
outputWorkflow, _ := globalEngine.GetWorkflow(localworkflows.WORKFLOWID_OUTPUT_WORKFLOW)
outputFlags := workflow.FlagsetFromConfigurationOptions(outputWorkflow.GetConfigurationOptions())
rootCommand.PersistentFlags().AddFlagSet(outputFlags)

// add workflows as commands
createCommandsForWorkflows(rootCommand, engine)
createCommandsForWorkflows(rootCommand, globalEngine)

// init NetworkAccess
networkAccess := engine.GetNetworkAccess()
networkAccess := globalEngine.GetNetworkAccess()
networkAccess.AddHeaderField("x-snyk-cli-version", cliv2.GetFullVersion())
networkAccess.AddHeaderField(
"User-Agent",
Expand All @@ -470,7 +469,7 @@ func MainWithErrorCode() int {
}

// init Analytics
cliAnalytics := engine.GetAnalytics()
cliAnalytics := globalEngine.GetAnalytics()
cliAnalytics.SetVersion(cliv2.GetFullVersion())
cliAnalytics.SetCmdArguments(os.Args[1:])
cliAnalytics.SetOperatingSystem(internalOS)
Expand Down
26 changes: 13 additions & 13 deletions cliv2/cmd/cliv2/main_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ import (
func cleanup() {
helpProvided = false
globalConfiguration = nil
engine = nil
globalEngine = nil
}

func Test_MainWithErrorCode(t *testing.T) {
Expand Down Expand Up @@ -99,7 +99,7 @@ func Test_CreateCommandsForWorkflowWithSubcommands(t *testing.T) {

globalConfiguration = configuration.New()
globalConfiguration.Set(configuration.DEBUG, true)
engine = workflow.NewWorkFlowEngine(globalConfiguration)
globalEngine = workflow.NewWorkFlowEngine(globalConfiguration)

fn := func(invocation workflow.InvocationContext, input []workflow.Data) ([]workflow.Data, error) {
return []workflow.Data{}, nil
Expand All @@ -110,17 +110,17 @@ func Test_CreateCommandsForWorkflowWithSubcommands(t *testing.T) {
for _, v := range commandList {
workflowConfig := workflow.ConfigurationOptionsFromFlagset(pflag.NewFlagSet("pla", pflag.ContinueOnError))
workflowId1 := workflow.NewWorkflowIdentifier(v)
_, err := engine.Register(workflowId1, workflowConfig, fn)
_, err := globalEngine.Register(workflowId1, workflowConfig, fn)
if err != nil {
t.Fatal(err)
}
}

_ = engine.Init()
_ = globalEngine.Init()
rootCommand := prepareRootCommand()

// invoke method under test
createCommandsForWorkflows(rootCommand, engine)
createCommandsForWorkflows(rootCommand, globalEngine)

// test that root subcmd2 has expected subcommands
cmd, _, _ := rootCommand.Find([]string{"cmd"})
Expand Down Expand Up @@ -174,7 +174,7 @@ func Test_runMainWorkflow_unknownargs(t *testing.T) {
defer cleanup()
globalConfiguration = configuration.New()
globalConfiguration.Set(configuration.DEBUG, true)
engine = workflow.NewWorkFlowEngine(globalConfiguration)
globalEngine = workflow.NewWorkFlowEngine(globalConfiguration)

fn := func(invocation workflow.InvocationContext, input []workflow.Data) ([]workflow.Data, error) {
return []workflow.Data{}, nil
Expand All @@ -185,13 +185,13 @@ func Test_runMainWorkflow_unknownargs(t *testing.T) {
for _, v := range commandList {
workflowConfig := workflow.ConfigurationOptionsFromFlagset(pflag.NewFlagSet("pla", pflag.ContinueOnError))
workflowId1 := workflow.NewWorkflowIdentifier(v)
_, err := engine.Register(workflowId1, workflowConfig, fn)
_, err := globalEngine.Register(workflowId1, workflowConfig, fn)
if err != nil {
t.Fatal(err)
}
}

_ = engine.Init()
_ = globalEngine.Init()

config := configuration.NewInMemory()
cmd := &cobra.Command{
Expand Down Expand Up @@ -297,10 +297,10 @@ func Test_runWorkflowAndProcessData(t *testing.T) {
defer cleanup()
globalConfiguration = configuration.New()
globalConfiguration.Set(configuration.DEBUG, true)
engine = workflow.NewWorkFlowEngine(globalConfiguration)
globalEngine = workflow.NewWorkFlowEngine(globalConfiguration)

testCmnd := "subcmd1"
addEmptyWorkflows(t, engine, []string{"output"})
addEmptyWorkflows(t, globalEngine, []string{"output"})

fn := func(invocation workflow.InvocationContext, input []workflow.Data) ([]workflow.Data, error) {
typeId := workflow.NewTypeIdentifier(invocation.GetWorkflowIdentifier(), "workflowData")
Expand Down Expand Up @@ -330,16 +330,16 @@ func Test_runWorkflowAndProcessData(t *testing.T) {
wrkflowId := workflow.NewWorkflowIdentifier(testCmnd)
workflowConfig := workflow.ConfigurationOptionsFromFlagset(pflag.NewFlagSet("pla", pflag.ContinueOnError))

entry, err := engine.Register(wrkflowId, workflowConfig, fn)
entry, err := globalEngine.Register(wrkflowId, workflowConfig, fn)
assert.Nil(t, err)
assert.NotNil(t, entry)

err = engine.Init()
err = globalEngine.Init()
assert.NoError(t, err)

// invoke method under test
logger := zerolog.New(os.Stderr)
err = runWorkflowAndProcessData(engine, &logger, testCmnd)
err = runWorkflowAndProcessData(globalEngine, &logger, testCmnd)
assert.ErrorIs(t, err, clierrors.ErrorWithExitCode{
ExitCode: constants.SNYK_EXIT_CODE_VULNERABILITIES_FOUND,
})
Expand Down

0 comments on commit b19ae31

Please sign in to comment.