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 -d ./workflows -w my-workflow

# Show workflow description with step descriptions
actor-iac describe -d ./workflows -w my-workflow --steps

# With overlay
actor-iac describe -d ./workflows -w my-workflow -o ./overlays/env --steps

Since:

2.10.0

Author:

devteam@scivics-lab.com

Field Summary

Fields

Modifier and Type	Field	Description
private File	overlayDir
private boolean	showSteps
private final Map<String,File>	workflowCache	Cache of discovered workflow files: name -> File
private File	workflowDir
private String	workflowName

Constructor Summary

Constructors

Constructor	Description
DescribeCLI()

Method Summary

Modifier and Type	Method	Description
Integer	call()
private File	findWorkflowFile(String name)	Finds a workflow file by name.
private static String	getBaseName(String fileName)	Gets the base name of a file (without extension).
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 void	scanWorkflowDirectory(File directory)	Scans the workflow directory recursively for workflow files.

Methods inherited from class Object

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

Field Details

workflowDir

private File workflowDir

workflowName

private String workflowName

overlayDir

private File overlayDir

showSteps

private boolean showSteps

workflowCache

private final Map<String,File> workflowCache

Cache of discovered workflow files: name -> File

Constructor Details

DescribeCLI

public DescribeCLI()

Method Details

call

public Integer call()

Specified by:

call in interface Callable<Integer>

printWorkflowDescription

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

Prints workflow description.

scanWorkflowDirectory

private void scanWorkflowDirectory(File directory)

Scans the workflow directory recursively for workflow files.

findWorkflowFile

private File findWorkflowFile(String name)

Finds a workflow file by name.

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.

getBaseName

private static String getBaseName(String fileName)

Gets the base name of a file (without extension).