Skip to content

feat:support flag to control log directory & handling kubeconfig duplicates #86

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.

Sign up for GitHub

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

Open
FAUST-BENCHOU wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat:support flag to control log directory & handling kubeconfig duplicates #86

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
25 changes: 24 additions & 1 deletion cmd/graph.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,9 +103,22 @@ func NewGraphRunCommand(factory *providerfactory.ProviderFactory, scenarioOrches
return err
}

outputDir, err := cmd.Flags().GetString("output")
if err != nil {
return err
}
var outputDirPath *string
if outputDir != "" {
expandedOutputDir, err := commonutils.ExpandFolder(outputDir, nil)
if err != nil {
return err
}
// Ensure output directory exists
if err = EnsureDirectory(*expandedOutputDir); err != nil {
return fmt.Errorf("failed to create output directory %s: %v", *expandedOutputDir, err)
}
outputDirPath = expandedOutputDir
}

kubeconfigPath, err := utils.PrepareKubeconfig(&kubeconfig, config)
if err != nil {
Expand All @@ -114,6 +127,12 @@ func NewGraphRunCommand(factory *providerfactory.ProviderFactory, scenarioOrches
if kubeconfigPath == nil {
return fmt.Errorf("kubeconfig not found: %s", kubeconfig)
}
// Clean up kubeconfig file on exit
defer func() {
if kubeconfigPath != nil {
_ = os.Remove(*kubeconfigPath)
}
}()
volumes[*kubeconfigPath] = config.KubeconfigPath

if metricsProfile != "" {
Expand Down Expand Up @@ -199,7 +218,7 @@ func NewGraphRunCommand(factory *providerfactory.ProviderFactory, scenarioOrches
commChannel := make(chan *models.GraphCommChannel)

go func() {
(*scenarioOrchestrator).RunGraph(nodes, executionPlan, environment, volumes, false, commChannel, registrySettings, nil)
(*scenarioOrchestrator).RunGraph(nodes, executionPlan, environment, volumes, false, commChannel, registrySettings, nil, outputDirPath)
}()

for {
Expand All @@ -222,6 +241,10 @@ func NewGraphRunCommand(factory *providerfactory.ProviderFactory, scenarioOrches
}
}
if exitOnerror {
// Clean up kubeconfig before exiting
if kubeconfigPath != nil {
_ = os.Remove(*kubeconfigPath)
}
_, err = color.New(color.FgHiRed).Println(fmt.Sprintf("aborting chaos run with exit status %d", staterr.ExitStatus))
if err != nil {
return err
Expand Down
2 changes: 1 addition & 1 deletion cmd/random.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -206,7 +206,7 @@ func NewRandomRunCommand(factory *providerfactory.ProviderFactory, scenarioOrche
commChannel := make(chan *models.GraphCommChannel)

go func() {
(*scenarioOrchestrator).RunGraph(nodes, executionPlan, environment, volumes, false, commChannel, registrySettings, nil)
(*scenarioOrchestrator).RunGraph(nodes, executionPlan, environment, volumes, false, commChannel, registrySettings, nil, nil)
}()

for {
Expand Down
1 change: 1 addition & 0 deletions cmd/root.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,7 @@ func Execute(providerFactory *factory.ProviderFactory, scenarioOrchestrator *sce
graphRunCmd.Flags().String("alerts-profile", "", "custom alerts profile file path")
graphRunCmd.Flags().String("metrics-profile", "", "custom metrics profile file path")
graphRunCmd.Flags().Bool("exit-on-error", false, "if set this flag will the workflow will be interrupted and the tool will exit with a status greater than 0")
graphRunCmd.Flags().StringP("output", "o", "", "output directory for log files (default: current working directory)")
graphScaffoldCmd := NewGraphScaffoldCommand(providerFactory, config)
graphScaffoldCmd.Flags().Bool("global-env", false, "if set this flag will add global environment variables to each scenario in the graph")
graphCmd.AddCommand(graphRunCmd)
Expand Down
6 changes: 6 additions & 0 deletions cmd/utils.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,12 @@ func CheckFileExists(filePath string) bool {
return true
}

// EnsureDirectory creates a directory if it doesn't exist
// Returns an error if the directory cannot be created
func EnsureDirectory(dirPath string) error {
return os.MkdirAll(dirPath, 0755)
}

func ParseFlags(scenarioDetail *models.ScenarioDetail, args []string, scenarioCollectedFlags map[string]*string, skipDefault bool) (env *map[string]ParsedField, vol *map[string]string, err error) {
environment := make(map[string]ParsedField)
volumes := make(map[string]string)
Expand Down
13 changes: 10 additions & 3 deletions pkg/scenarioorchestrator/common_functions.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ func CommonRunGraph(
config config.Config,
registry *providermodels.RegistryV2,
userID *int,
outputDir *string,
) {
for step, s := range resolvedGraph {
var wg sync.WaitGroup
Expand Down Expand Up @@ -66,20 +67,26 @@ func CommonRunGraph(

containerName := utils.GenerateContainerName(config, scenario.Name, &scID)
filename := fmt.Sprintf("%s.log", containerName)
file, err := os.Create(path.Clean(filename))
var logPath string
if outputDir != nil && *outputDir != "" {
logPath = path.Join(*outputDir, filename)
} else {
logPath = path.Clean(filename)
}
file, err := os.Create(logPath)

if err != nil {
commChannel <- &models.GraphCommChannel{Layer: nil, ScenarioID: nil, ScenarioLogFile: nil, Err: err}
return
}
commChannel <- &models.GraphCommChannel{Layer: &step, ScenarioID: &scID, ScenarioLogFile: &filename, Err: nil}
commChannel <- &models.GraphCommChannel{Layer: &step, ScenarioID: &scID, ScenarioLogFile: &logPath, Err: nil}
wg.Add(1)

go func() {
defer wg.Done()
_, err = orchestrator.RunAttached(scenario.Image, containerName, env, cache, volumes, file, file, nil, ctx, registry)
if err != nil {
commChannel <- &models.GraphCommChannel{Layer: &step, ScenarioID: &scID, ScenarioLogFile: &filename, Err: err}
commChannel <- &models.GraphCommChannel{Layer: &step, ScenarioID: &scID, ScenarioLogFile: &logPath, Err: err}
return
}
}()
Expand Down
3 changes: 2 additions & 1 deletion pkg/scenarioorchestrator/docker/scenario_orchestrator.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -466,8 +466,9 @@ func (c *ScenarioOrchestrator) RunGraph(
commChannel chan *orchestratormodels.GraphCommChannel,
registry *providermodels.RegistryV2,
userID *int,
outputDir *string,
) {
scenarioorchestrator.CommonRunGraph(scenarios, resolvedGraph, extraEnv, extraVolumeMounts, cache, commChannel, c, c.Config, registry, userID)
scenarioorchestrator.CommonRunGraph(scenarios, resolvedGraph, extraEnv, extraVolumeMounts, cache, commChannel, c, c.Config, registry, userID, outputDir)
}

func (c *ScenarioOrchestrator) PrintContainerRuntime() {
Expand Down
3 changes: 2 additions & 1 deletion pkg/scenarioorchestrator/podman/scenario_orchestrator.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -373,9 +373,10 @@ func (c *ScenarioOrchestrator) RunGraph(
commChannel chan *orchestratormodels.GraphCommChannel,
registry *providermodels.RegistryV2,
userID *int,
outputDir *string,
) {
//TODO: add a getconfig method in scenarioOrchestrator
scenarioorchestrator.CommonRunGraph(scenarios, resolvedGraph, extraEnv, extraVolumeMounts, cache, commChannel, c, c.Config, registry, userID)
scenarioorchestrator.CommonRunGraph(scenarios, resolvedGraph, extraEnv, extraVolumeMounts, cache, commChannel, c, c.Config, registry, userID, outputDir)
}

func (c *ScenarioOrchestrator) PrintContainerRuntime() {
Expand Down
1 change: 1 addition & 0 deletions pkg/scenarioorchestrator/scenario_orchestrator.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ type ScenarioOrchestrator interface {
commChannel chan *orchestrator_models.GraphCommChannel,
registry *models.RegistryV2,
userID *int,
outputDir *string,
)

CleanContainers(ctx context.Context) (*int, error)
Expand Down
4 changes: 2 additions & 2 deletions pkg/scenarioorchestrator/scenarioorchestratortest/common_test_functions.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -330,7 +330,7 @@ func CommonTestScenarioOrchestratorRunGraph(t *testing.T, so scenarioorchestrato

commChannel := make(chan *models.GraphCommChannel)
go func() {
so.RunGraph(nodes, executionPlan, map[string]string{}, map[string]string{}, false, commChannel, nil, uid)
so.RunGraph(nodes, executionPlan, map[string]string{}, map[string]string{}, false, commChannel, nil, uid, nil)
}()

for {
Expand Down Expand Up @@ -406,7 +406,7 @@ func CommonTestScenarioOrchestratorRunGraph(t *testing.T, so scenarioorchestrato

commChannel = make(chan *models.GraphCommChannel)
go func() {
so.RunGraph(nodes, executionPlan, map[string]string{}, map[string]string{}, false, commChannel, nil, uid)
so.RunGraph(nodes, executionPlan, map[string]string{}, map[string]string{}, false, commChannel, nil, uid, nil)
}()

for {
Expand Down