Class DescribeCLI

java.lang.Object

com.scivicslab.actoriac.cli.DescribeCLI

All Implemented Interfaces:

Callable<Integer>

public class DescribeCLI
extends Object
implements Callable<Integer>

CLI subcommand for displaying workflow descriptions.

Usage examples:

# Show workflow description only
actor-iac describe -w sysinfo/main-collect-sysinfo.yaml

# Show workflow description with step descriptions
actor-iac describe -w sysinfo/main-collect-sysinfo.yaml --steps

# With overlay
actor-iac describe -w sysinfo/main-collect-sysinfo.yaml -o ./overlays/env --steps

Since:

2.10.0

Author:

devteam@scivicslab.com

Field Summary

Fields

Modifier and Type	Field	Description
private File	baseDir
private File	overlayDir
private boolean	showSteps
private String	workflowPath

Constructor Summary

Constructors

Constructor	Description
DescribeCLI()

Method Summary

Modifier and Type	Method	Description
Integer	call()
private Map<String,Object>	loadYamlFile(File file)	Loads a YAML file.
private Map<String,Object>	loadYamlWithOverlay(File workflowFile)	Loads a YAML file with overlay applied.
private void	printWorkflowDescription(File file, Map<String,Object> yaml)	Prints workflow description.
private File	resolveWorkflowFile(File file)	Resolves the workflow file, trying extensions if the file doesn't exist.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

baseDir

private File baseDir

workflowPath

private String workflowPath

overlayDir

private File overlayDir

showSteps

private boolean showSteps

Constructor Details

DescribeCLI

public DescribeCLI()

Method Details

call

public Integer call()

Specified by:

call in interface Callable<Integer>

resolveWorkflowFile

private File resolveWorkflowFile(File file)

Resolves the workflow file, trying extensions if the file doesn't exist.

printWorkflowDescription

private void printWorkflowDescription(File file,
 Map<String,Object> yaml)

Prints workflow description.

loadYamlFile

private Map<String,Object> loadYamlFile(File file)

Loads a YAML file.

loadYamlWithOverlay

private Map<String,Object> loadYamlWithOverlay(File workflowFile)

Loads a YAML file with overlay applied.