Add step description and test point to list command

[k2tzumi]

I would like to propose a feature request for runn. I want to display the step description and the test point for each step in the list command.

The step description is the value of the desc key defined in each step. If there is no desc key, I want to display the physical name of the step.

The test point is the content of the test section defined in each step. Currently, the test content is specified by an evaluation expression, and there is no function to write a human-readable test point. However, currently, comments can be left in the test expression. I think it would be nice if I could extract the comments and display them as test points.

In the future, I would like to be able to extend the test section to write an explanation for each expression.

I also want to support markdown output for the list command along with the above features. The list command output becomes complex with the addition of step description and test point. I think it would be easier to read and review the scenario patterns and test points in markdown format. The purpose is to help third parties understand the scenario and the API behavior.

[k1LoW]

@k2tzumi Thank you for your idea!

About runn ls

The runn ls command is still in its developing stages. As its name suggests, it is a "list up" command.
We will need to consider what should be listed. At the very least, it should not display details.

It would be good to consider what should be displayed assuming a hypothetical listing of 1000 runbooks.

About test runner

Since runn is not a tool for testing only, I am not comfortable giving special treatment to test runners only.

I want to successfully integrate real-world use cases with runn's design philosophy.

About docs

I think it is an interesting idea. I am also interested in documentation.

However, a different subcommand from runn ls looks good.

[k2tzumi]

However, a different subcommand from runn ls looks good.

runn book scenario viewer!!
I would like to provide the processing of the runn book analysis itself as a function of the runn module.

[k1LoW]

runn book scenario viewer!!

I think it's an interesting idea!

If you are going to specialize in analysis for API testing, it might be better to offer it as a separate tool.

Because runn is a tool that supports a bit broader scope than API testing.