pull in help->man command changes (#100)
* Autodetects framework [Closes #87] * use the StringTemplate template engine Replaces the generation of config files using serialization techniques with the use of a template engine. Initially the idea was to use Steeltoe.Initializr however StringTemplate turned out to be a better fit. [closes #96] * explicitly fail if oper not done in proper state [closes #75] * Update azure-pipelines.yml * Fix test on Windows * Disable test * Revamp of CLI for .0.7.0-rc1 release [Closes #64] adds 'show' command [Closes #69] uses docker compoes to deploy app services [Closes #74] autodetects services Squashed commit of the following: commitb77cbb93d2Merge:c5f8855ffb6429Author: Chris Cheetham <chris@cheetham.com> Date: Thu Mar 26 08:11:23 2020 -0400 Merge branch 'tack' of github.com:SteeltoeOSS/Tooling into tack commitc5f8855c6aAuthor: Chris Cheetham <chris@cheetham.com> Date: Thu Mar 26 08:09:22 2020 -0400 fix url listing commit4f3ec442c6Author: Chris Cheetham <chris@cheetham.com> Date: Thu Mar 26 08:05:27 2020 -0400 add services to docker commit7da7963ebcAuthor: Chris Cheetham <chris@cheetham.com> Date: Thu Mar 26 07:45:21 2020 -0400 external nugets and some other rearrangements commit3607fd4a5aAuthor: Chris Cheetham <chris@cheetham.com> Date: Thu Mar 26 07:15:14 2020 -0400 dn not assume a particular profile commit90278e0dd6Author: Chris Cheetham <chris@cheetham.com> Date: Wed Mar 25 21:55:41 2020 -0400 add service dependency detection commit01e6ab7326Author: Chris Cheetham <chris@cheetham.com> Date: Wed Mar 25 20:31:26 2020 -0400 prep for service dependency support, part 2 commit091203ade8Author: Chris Cheetham <chris@cheetham.com> Date: Wed Mar 25 19:55:47 2020 -0400 fix console assignment commitd302207405Author: Chris Cheetham <chris@cheetham.com> Date: Wed Mar 25 19:45:57 2020 -0400 prep for service dependency support commitb877e7cf96Author: Chris Cheetham <chris@cheetham.com> Date: Wed Mar 25 19:22:31 2020 -0400 assume a default set of services commita46277d004Author: Chris Cheetham <chris@cheetham.com> Date: Wed Mar 25 17:56:47 2020 -0400 add netcoreapp2.1 commit0d981b6aa4Author: Chris Cheetham <chris@cheetham.com> Date: Wed Mar 25 17:55:50 2020 -0400 externalize image registry commit3d66fbe385Author: Chris Cheetham <chris@cheetham.com> Date: Wed Mar 25 16:27:29 2020 -0400 guess framework commit9fa324a198Author: Chris Cheetham <chris@cheetham.com> Date: Wed Mar 25 15:56:16 2020 -0400 impls stop commit0476ea3c78Author: Chris Cheetham <chris@cheetham.com> Date: Wed Mar 25 15:51:08 2020 -0400 impls run commit13b22b819fAuthor: Chris Cheetham <chris@cheetham.com> Date: Wed Mar 25 14:41:25 2020 -0400 prepare for running in docker commit93eeb1b43eAuthor: Chris Cheetham <chris@cheetham.com> Date: Wed Mar 25 13:20:20 2020 -0400 add some safety handling commitfc5b997c51Author: Chris Cheetham <chris@cheetham.com> Date: Wed Mar 25 12:47:37 2020 -0400 impl show commit2e95c94407Author: Chris Cheetham <chris@cheetham.com> Date: Mon Feb 17 11:22:33 2020 -0500 update help help commit46511296e5Author: Chris Cheetham <chris@cheetham.com> Date: Mon Feb 17 11:19:14 2020 -0500 rename command show-topic to help commita147888d8fAuthor: Chris Cheetham <chris@cheetham.com> Date: Mon Feb 17 11:12:13 2020 -0500 impl show-topic command commit35a913b2a5Author: Chris Cheetham <chris@cheetham.com> Date: Mon Feb 17 09:34:43 2020 -0500 update show-topic help commitaa9a7c1ad1Author: Chris Cheetham <chris@cheetham.com> Date: Mon Feb 17 08:55:09 2020 -0500 factor out models commit2854fa45edAuthor: Chris Cheetham <chris@cheetham.com> Date: Sun Feb 16 12:17:32 2020 -0500 tidy commit9f2789bf64Author: Chris Cheetham <chris@cheetham.com> Date: Sat Feb 15 12:30:19 2020 -0500 stub new commands commitffb6429a02Author: Chris Cheetham <chris@cheetham.com> Date: Thu Mar 26 08:09:22 2020 -0400 fix url listing commita61d87a613Author: Chris Cheetham <chris@cheetham.com> Date: Thu Mar 26 08:05:27 2020 -0400 add services to docker commitd41e137f01Author: Chris Cheetham <chris@cheetham.com> Date: Thu Mar 26 07:45:21 2020 -0400 external nugets and some other rearrangements commit430841be02Author: Chris Cheetham <chris@cheetham.com> Date: Thu Mar 26 07:15:14 2020 -0400 dn not assume a particular profile commit90df4ff676Author: Chris Cheetham <chris@cheetham.com> Date: Wed Mar 25 21:55:41 2020 -0400 add service dependency detection commitd874e0fa22Author: Chris Cheetham <chris@cheetham.com> Date: Wed Mar 25 20:31:26 2020 -0400 prep for service dependency support, part 2 commit0df0cf2f18Author: Chris Cheetham <chris@cheetham.com> Date: Wed Mar 25 19:55:47 2020 -0400 fix console assignment commit84bd775056Author: Chris Cheetham <chris@cheetham.com> Date: Wed Mar 25 19:45:57 2020 -0400 prep for service dependency support commit1170f4837dAuthor: Chris Cheetham <chris@cheetham.com> Date: Wed Mar 25 19:22:31 2020 -0400 assume a default set of services commitaabf7dba8fAuthor: Chris Cheetham <chris@cheetham.com> Date: Wed Mar 25 17:56:47 2020 -0400 add netcoreapp2.1 commit19d5d4745eAuthor: Chris Cheetham <chris@cheetham.com> Date: Wed Mar 25 17:55:50 2020 -0400 externalize image registry commitbd7755410bAuthor: Chris Cheetham <chris@cheetham.com> Date: Wed Mar 25 16:27:29 2020 -0400 guess framework commit33ab8d9db7Author: Chris Cheetham <chris@cheetham.com> Date: Wed Mar 25 15:56:16 2020 -0400 impls stop commit7188a75bdbAuthor: Chris Cheetham <chris@cheetham.com> Date: Wed Mar 25 15:51:08 2020 -0400 impls run commitab75cdf8d5Author: Chris Cheetham <chris@cheetham.com> Date: Wed Mar 25 14:41:25 2020 -0400 prepare for running in docker commit5db35fdf00Author: Chris Cheetham <chris@cheetham.com> Date: Wed Mar 25 13:20:20 2020 -0400 add some safety handling commit80d3c7dd69Author: Chris Cheetham <chris@cheetham.com> Date: Wed Mar 25 12:47:37 2020 -0400 impl show commit454217e4aaAuthor: Chris Cheetham <chris@cheetham.com> Date: Mon Feb 17 11:22:33 2020 -0500 update help help commiteda4ca38eeAuthor: Chris Cheetham <chris@cheetham.com> Date: Mon Feb 17 11:19:14 2020 -0500 rename command show-topic to help commit178d8b60aeAuthor: Chris Cheetham <chris@cheetham.com> Date: Mon Feb 17 11:12:13 2020 -0500 impl show-topic command commit83c66d1b90Author: Chris Cheetham <chris@cheetham.com> Date: Mon Feb 17 09:34:43 2020 -0500 update show-topic help commit9ae1542a3dAuthor: Chris Cheetham <chris@cheetham.com> Date: Mon Feb 17 08:55:09 2020 -0500 factor out models commit246f7b672eAuthor: Chris Cheetham <chris@cheetham.com> Date: Sun Feb 16 12:17:32 2020 -0500 tidy commitf9fa4cd902Author: Chris Cheetham <chris@cheetham.com> Date: Sat Feb 15 12:30:19 2020 -0500 stub new commands * Tidy * Bump version to 0.7.0 * Allow test to pass regardless of framework * Explicitly set framework version * Install DotNet 3.1 * Fix pipeline indentation * Add netcoreapp2.1 and netcoreapp3.1 support * Install DotNet 2.1 * Doc updates * Tidy docs * Update README.adoc Adding note to assist with any path issues. * Update src/Steeltoe.Tooling/steeltoe.rc/registry/dependencies.yml Co-authored-by: Tim Hess <thess@pivotal.io> * Rename "help" command to "man" * Add headings to topic list * No longer part of repo * Tidy white space * Fix branch * Fix CI trigger for dev * Fix backwords merge * Restore master settings Co-authored-by: Tim Hess <thess@pivotal.io> Co-authored-by: Jason Konicki <jkonicki@users.noreply.github.com>
This commit is contained in:
Chris Cheetham
GitHub
Родитель
4b16cc1a16
Коммит
f66daa55b1
|
|
@ -29,8 +29,8 @@ $ dotnet tool install -g Steeltoe.Cli --version 0.7.0-1904 --add-source https://
|
|||
You can invoke the tool using the following command: st
|
||||
Tool 'steeltoe.cli' (version '0.7.0-1904') was successfully installed.
|
||||
|
||||
# NOTE: The dotnet tool option requires adding the tools path to the PATH variable in your environment.
|
||||
# This must be done before the next step.
|
||||
# NOTE: The dotnet tool option requires adding the tools path to the PATH variable in your environment.
|
||||
# This must be done before the next step.
|
||||
|
||||
$ st --version
|
||||
0.7.0 (build 1904 -> https://dev.azure.com/SteeltoeOSS/Steeltoe/_build/results?buildId=1904)
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
trigger:
|
||||
- master
|
||||
- dev
|
||||
- refs/tags/*
|
||||
- dev
|
||||
|
||||
variables:
|
||||
Solution: 'Tooling'
|
||||
|
|
|
|||
|
|
@ -34,14 +34,14 @@ Examples:
|
|||
Display documentation for autodetection:
|
||||
$ st help autodetection"
|
||||
)]
|
||||
public class HelpCommand : Command
|
||||
public class ManCommand : Command
|
||||
{
|
||||
public const string CommandName = "help";
|
||||
public const string CommandName = "man";
|
||||
|
||||
[Argument(0, Name = "topic", Description = "Topic")]
|
||||
private string Topic { get; } = null;
|
||||
|
||||
public HelpCommand(IConsole console) : base(console)
|
||||
public ManCommand(IConsole console) : base(console)
|
||||
{
|
||||
}
|
||||
|
||||
|
|
@ -86,6 +86,7 @@ Examples:
|
|||
var maxTopicLength = topicPaths.Select(Path.GetFileNameWithoutExtension)
|
||||
.Select(topic => topic.Length).Concat(new[] {0}).Max();
|
||||
var descriptionColumn = maxTopicLength + 4;
|
||||
Context.Console.WriteLine("Topic".PadRight(descriptionColumn) + "Description");
|
||||
foreach (var topicPath in topicPaths)
|
||||
{
|
||||
var topic = Path.GetFileNameWithoutExtension(topicPath);
|
||||
|
|
@ -20,7 +20,7 @@ namespace Steeltoe.Cli
|
|||
{
|
||||
[Command(Name = Name, Description = "Steeltoe Developer Tools")]
|
||||
[VersionOptionFromMember("-V|--version", MemberName = nameof(GetVersion))]
|
||||
[Subcommand(HelpCommand.CommandName, typeof(HelpCommand))]
|
||||
[Subcommand(ManCommand.CommandName, typeof(ManCommand))]
|
||||
[Subcommand(RunCommand.CommandName, typeof(RunCommand))]
|
||||
[Subcommand(ShowCommand.CommandName, typeof(ShowCommand))]
|
||||
[Subcommand(StopCommand.CommandName, typeof(StopCommand))]
|
||||
|
|
|
|||
|
|
@ -17,19 +17,19 @@ using LightBDD.XUnit2;
|
|||
|
||||
namespace Steeltoe.Cli.Test
|
||||
{
|
||||
public class HelpFeature : FeatureSpecs
|
||||
public class ManFeature : FeatureSpecs
|
||||
{
|
||||
[Scenario]
|
||||
public void HelpHelp()
|
||||
public void ManHelp()
|
||||
{
|
||||
Runner.RunScenario(
|
||||
given => an_empty_directory("help_help"),
|
||||
when => the_developer_runs_cli_command("help --help"),
|
||||
given => an_empty_directory("man_help"),
|
||||
when => the_developer_runs_cli_command("man --help"),
|
||||
then => the_cli_command_should_succeed(),
|
||||
and => the_cli_should_output(new[]
|
||||
{
|
||||
"Displays documentation on a topic",
|
||||
$"Usage: {Program.Name} help [arguments] [options]",
|
||||
$"Usage: {Program.Name} man [arguments] [options]",
|
||||
"Arguments:",
|
||||
"topic Topic",
|
||||
"Options:",
|
||||
|
|
@ -46,45 +46,46 @@ namespace Steeltoe.Cli.Test
|
|||
}
|
||||
|
||||
[Scenario]
|
||||
public void HelpTooManyArgs()
|
||||
public void ManTooManyArgs()
|
||||
{
|
||||
Runner.RunScenario(
|
||||
given => an_empty_directory("help_too_many_args"),
|
||||
when => the_developer_runs_cli_command("help arg1 arg2"),
|
||||
given => an_empty_directory("man_too_many_args"),
|
||||
when => the_developer_runs_cli_command("man arg1 arg2"),
|
||||
then => the_cli_should_fail_parse("Unrecognized command or argument 'arg2'")
|
||||
);
|
||||
}
|
||||
|
||||
[Scenario]
|
||||
public void HelpTopicList()
|
||||
public void ManTopicList()
|
||||
{
|
||||
Runner.RunScenario(
|
||||
given => an_empty_directory("help_topic_list"),
|
||||
when => the_developer_runs_cli_command("help"),
|
||||
given => an_empty_directory("man_topic_list"),
|
||||
when => the_developer_runs_cli_command("man"),
|
||||
then => the_cli_command_should_succeed(),
|
||||
and => the_cli_should_output(new[]
|
||||
{
|
||||
"Topic Description",
|
||||
"autodetection Application and Service Autodetection",
|
||||
})
|
||||
);
|
||||
}
|
||||
|
||||
[Scenario]
|
||||
public void HelpNotFound()
|
||||
public void ManTopicNotFound()
|
||||
{
|
||||
Runner.RunScenario(
|
||||
given => an_empty_directory("help_topic_not_found"),
|
||||
when => the_developer_runs_cli_command("help no-such-topic"),
|
||||
given => an_empty_directory("man_topic_not_found"),
|
||||
when => the_developer_runs_cli_command("man no-such-topic"),
|
||||
then => the_cli_should_error(ErrorCode.Tooling, "Topic does not exist: no-such-topic")
|
||||
);
|
||||
}
|
||||
|
||||
[Scenario]
|
||||
public void HelpAutodetection()
|
||||
public void ManAutodetection()
|
||||
{
|
||||
Runner.RunScenario(
|
||||
given => an_empty_directory("help_topic_autodetection"),
|
||||
when => the_developer_runs_cli_command("help autodetection"),
|
||||
given => an_empty_directory("man_topic_autodetection"),
|
||||
when => the_developer_runs_cli_command("man autodetection"),
|
||||
then => the_cli_command_should_succeed(),
|
||||
and => the_cli_should_output(new[]
|
||||
{
|
||||
|
|
@ -48,7 +48,7 @@ namespace Steeltoe.Cli.Test
|
|||
"-D|--debug Enable debug output",
|
||||
"-?|-h|--help Show help information",
|
||||
"Commands:",
|
||||
"help Displays documentation on a topic",
|
||||
"man Displays documentation on a topic",
|
||||
"run Runs project in the local Docker environment",
|
||||
"show Displays project details",
|
||||
"stop Stops project running in the local Docker environment",
|
||||
|
|
|
|||
Загрузка…
Ссылка в новой задаче