Skip to:

  1. Skip to Jira Navigation
  2. Skip to Side Navigation
  3. Skip to Main Content

Create a new hpcc command line tool

Description

I suggest introducing a new command line tool which can be used to call any service within esp. It would take the xml files generated from the scm files for the esp services and use them to dynamically configure a tool for calling those services.

The syntax would be something like

e.g.

A few characteristics:

  • It should be completely generalised with no special casing - configured purely by the xml files.

  • It should be integrated with the linux command completion and provide context sensitive completion.

  • It should have build in help, also generated from the xml files.

  • Extension: The output could be controlled to use json/xml and it could use xpath to extract values from the result.

  • It would initially only support scalar arguments. Very few (no?) services have complex parameters.

This would be useful

i) for testing the apis
ii) for learning what the apis are.
iii) For users to automate tasks that do not currently have specialised implementations within the other command line tools.

please add any other comments/observations.

Conclusion

None

Activity

Show:

HPCC JiraBot August 5, 2024 at 6:26 PM

Jirabot Action Result:
Workflow Transition: Merge Pending
Updated PR

Gavin Halliday December 15, 2023 at 12:12 PM

I think would be a good potential mentor.

Hugo Watanuki December 15, 2023 at 6:18 AM

, fyi, I have drafted the following project description for the wiki in case this is still a potential intern project:  https://wiki.hpccsystems.com/display/hpcc/Create+a+new+hpcc+command+line+tool

In case affirmative, I am wondering if you would have any suggestions for potential mentors?

Anthony Fishbeck November 14, 2023 at 10:56 PM

Note that the ESDL information in the ecm files (which as Gavin said is the source of the xml content) is extensible.  You can add new attributes to the esdl without affecting other tools/uses.

This can come in very handy.

For example you could add an attribute cli_usage("some usage info") that could be added to a method, or an input parameter that could be added to the help that is displayed,

or you could add cli_ignore to an input value that doesn't make sense for the command line to accept, or display help for.

Also note that the ESDL supports the versioning of fields and even entire methods.  The command line can support that versioning, by default only supporting/displaying help for parameters that are included in the current version.

You could also allow the user to specify the version they want to use to override the default, although that could be done as a separate sub task.

 

 

 

Hugo Watanuki November 14, 2023 at 2:58 PM

Thanks   I will add/track this in the list of project ideas for 2024.

Fixed
Pinned fields
Click on the next to a field label to start pinning.

Details

Components

Assignee

Reporter

Priority

Fix versions

Pull Request URL

https://github.com/hpcc-systems/HPCC-Platform/pull/18955

Created November 13, 2023 at 5:35 PM
Updated November 12, 2024 at 5:28 PM
Resolved August 29, 2024 at 4:24 PM