Generating a command line interface for projects based on configuration management technologies

Patent metadata

Field	Value
Publication number	US-2020379788-A1
Application number	US-201916424666-A
Country	US
Kind code	A1
Filing date	May 29, 2019
Priority date	May 29, 2019
Publication date	Dec 3, 2020
Grant date	—

Abstract

Implementations for generating a command line interface (CLI) for projects based on configuration management technologies are described. An example method may include maintaining a CLI specification file for a project that is executable by a configuration management system, the CLI specification file specifying an entry point to cause execution of the project, a command to invoke the project via the entry point, and option parameters of options of the project, receiving an invocation request for the project via a user input of the command, verifying that arguments of the invocation request are valid in view of the option parameters of the CLI specification file, and responsive to verifying that the arguments are valid, generating a CLI for the project in view of the CLI specification file, the CLI to cause the project to be executed by the configuration management system using the entry point.

First claim

What is claimed is:

1 . A method comprising:
maintaining, by a processing device, a command line interface (CLI) specification file for a project that is executable by a configuration management system, the CLI specification file specifying an entry point to cause execution of the project, a command to invoke the project via the entry point, and option parameters of options of the project; receiving an invocation request for the project via a user input of the command; verifying that arguments of the invocation request are valid in view of the option parameters of the CLI specification file; and responsive to verifying that the arguments are valid, generating a CLI for the project in view of the CLI specification file, the CLI to cause the project to be executed by the configuration management system using the entry point.

2 . The method of claim 1 , wherein the option parameters comprise a type of input for a respective option of the options, a help message description for the respective option, and a required indication for the respective option.

3 . The method of claim 2 , wherein the type of input comprises one of a string value, a Boolean value, or a comma-separated list.

4 . The method of claim 1 , wherein responsive to verifying that the arguments are invalid, issuing an exception in response to the invocation request.

5 . The method of claim 4 , wherein the exception identifies the option parameter that is invalid.

6 . The method of claim 1 , wherein generating the CLI further comprises converting the invocation request to a domain specific language (DSL)-based command of the configuration management system that references the entry point.

7 . The method of claim 1 , wherein the inputs of the CLI specification file are received via a sequence of dialog boxes that guide a user through a series of defined operations corresponding to the inputs of the CLI specification file.

8 . The method of claim 1 , wherein the CLI specification file is generated in view of a template CLI specification file.

9 . The method of claim 1 , wherein the invocation request for the project is generated upon automatically accessing the CLI specification file in response to execution of the configuration management system without receiving arguments.

10 . A system comprising:
a memory; and a processing device communicably coupled to the memory to:
maintain, by a processing device, a command line interface (CLI) specification file for a project that is executable by a configuration management system, the CLI specification file specifying an entry point to cause execution of the project, a command to invoke the project via the entry point, and option parameters of options of the project;
receive an invocation request for the project via a user input of the command;
verify that arguments of the invocation request are valid in view of the option parameters of the CLI specification file; and
responsive to verifying that the arguments are valid, generate a CLI for the project in view of the CLI specification file, the CLI to cause the project to be executed by the configuration management system using the entry point.

11 . The system of claim 10 , wherein the option parameters comprise a type of input for a respective option of the options, a help message description for the respective option, and a required indication for the respective option.

12 . The system of claim 10 , wherein responsive to verifying that the arguments are invalid, the processing device is to issue an exception in response to the invocation request.

13 . The system of claim 10 , wherein the processing device to generate the CLI further comprises the processing device to convert the invocation request to a domain specific language (DSL)-based command of the configuration management system that references the entry point.

14 . The system of claim 10 , wherein the inputs of the CLI specification file are received via a sequence of dialog boxes that guide a user through a series of defined operations corresponding to the inputs of the CLI specification file.

15 . The system of claim 10 , wherein the invocation request for the project via the command is generated upon automatically accessing the CLI specification file in response to execution of the configuration management system without receiving arguments.

16 . A non-transitory machine-readable storage medium storing instructions that cause a processing device to:
receive an invocation request comprising a defined command corresponding to a command line interface (CLI) specification file for a project that is executable by a configuration management system; access the CLI specification file corresponding to the defined command; determine whether arguments provided with the invocation request comply with defined option parameters in the CLI specification file; responsive to determining that the arguments comply with the defined option parameters, convert, in view of the CLI specification file, the invocation request to an executable command in a domain specific language (DSL) of the configuration management system; and cause the executable command to be executed by the configuration management system to run the project.

17 . The non-transitory machine-readable storage medium of claim 16 , wherein CLI specification file comprises an entry point to cause execution of the project, the command to invoke the project via the entry point, the defined option parameters of options of the project, and wherein the defined option parameters comprise a type of input for a respective option of the options, a help message description for the respective option, and a required indication for the respective option.

18 . The non-transitory machine-readable storage medium of claim 17 , wherein the executable command references the entry point.

19 . The non-transitory machine-readable storage medium of claim 16 , wherein responsive to determining that the arguments complies with the defined option parameters, issuing an exception in response to the invocation request.

20 . The non-transitory machine-readable storage medium of claim 16 , wherein inputs of the CLI specification file are received via a sequence of dialog boxes that guides a user through a series of defined operations corresponding to the inputs of the CLI specification file.

Assignees

• Red Hat Inc

Inventors

• Bregman Arie
• Kuris Eran

Classifications

• H04L67/10

  in which an application is distributed across nodes in the network (software deployment G06F8/60; multiprogramming arrangements G06F9/46) · CPC title

• H04L67/34

  involving the movement of software or configuration parameters  (network booting or remote initial program loading [RIPL] G06F9/4416) · CPC title

• G06F9/45512 Primary

  Command shells · CPC title

• G06F8/60

  Software deployment · CPC title

• G06F9/45533

  Hypervisors; Virtual machine monitors · CPC title