cmd/ie/commands: Use `RunE` instead of `Run` to make code simpler #83

blanquicet · 2023-10-05T11:07:07Z

Using RunE instead of Run prevents us from logging and printing the error, manually displaying the help and force-exiting every time. In other words, we can pass from this:

	logging.GlobalLogger.Errorf("Error: Invalid environment variable format: %s", environmentVariable)
	fmt.Printf("Error: Invalid environment variable format: %s", environmentVariable)
	cmd.Help()
	os.Exit(1)

To this:

	return fmt.Errorf("invalid environment variable format: %s", environmentVariable)

Doing so, the error will be logged and printed here:

https://github.com/blanquicet/InnovationEngine/blob/44b942573b8cdd7fbc999739074a75cb79af7193/cmd/ie/commands/root.go#L44-L45

And the cobra library will take care of printing the help.

* Created main.py and am doing a test commit * test commit * test commit * Parses a markdown file and pulls out headings, code blocks, and paragraphs * took away a few magic values & cleaned up code a bit * added the initial executor code complete with repl behavior, by no means complete and it will have bugs but it would be good to get some eyes on it before I go too much further * added a few more comments and deleted a few unused functions * Added testing directions of using python3 main.py to test * Added automated testing functionality with fuzzy matching * cleaned up code a bit and added test functionality * testing * Added github actions for automated testing * Fixing github actions * bug fix for actions * Added push to main as a trigger * bug fix * testing * changed file type to yml * testing * fixed bug with fuzzywuzzy * changing sensitivity so that actions should fail as there is a warning * Changing Sensitivity and adjust actions test * testing * test should pass now * Trying to enable manual workflow trigger * testing github actions * Changing default test * added the ability to set command line variables from both comments and .ini files which are key value pairs * updated README.md and added new test scripts * fixed test file and changed github action to point to test file not readme * Hardedned program to deal with broken markdown files, there is still no good way to deal with interactive bash commands though * added some exception handling so the program doesn't crash on a timeout * Changed Parser file class to MarkdownParser to avoid name clash with std parser, added test scripts folder for testing, and added some additional error handling for commands * removing exit(1) from test section as it terminates early if multiple files are being tested * removed exit(1) from main when file does not parse correctly * removed exit 1 to stop early failures with multiple files * adding random string to end of resource group in testing section so that there are not name conflicts. Catch is the document itself has to use MY_RESOURCE_GROUP_NAME as the variable for testing * cleaned up file structure and fixed a few bugs in Readme.md * added verion locks to requirements.txt, deleted hardcoded vm create document, added .vscode to .gitignore, and modified test script to work based on new location

* Improve getting started docs 1. fix capitlization error 2. use virtual environment 3. separate installation from running * Switch to interactive mode Co-authored-by: jasonmesser7 <91570951+jasonmesser7@users.noreply.github.com> --------- Co-authored-by: jasonmesser7 <91570951+jasonmesser7@users.noreply.github.com>

)

* first draft of AKS quick start with event grid notfications * Added tutorial with AKS create + Subscribing to event grid notifications * Add tests for all steps, plus a few docs improvements. --------- Co-authored-by: Ross Gardler <nope@no.no>

…lti tenancy, however we need this signal for an action to fail and block a PR (Azure#15)

…from the markdown codeblocks.

…outputs from the top level.

…d INI initialization to ie execute.

…ct comments.

…narios.

* [update] sed statement to use single quotations to avoid expansion during variable rendering and format document. * [update] command rendering failures to be reported. * [fix] resource URIs not being found.

… running in cloud shell. (Azure#101)

* Fixed errors on AKS doc * Fixed errors on AKS doc * Fixed errors on AKS doc * Fixed scenario bugs and cleaned text * Reverted dns name change * Fixed styling issues * Reverting moving around variable declarations and small text changes --------- Co-authored-by: Mitchell Bifeld <mbifeld@Mitchell-Surface>

Fix multi-line command rendering and disable inline rendering

Bumps [golang.org/x/net](https://github.com/golang/net) from 0.8.0 to 0.17.0. - [Commits](golang/net@v0.8.0...v0.17.0) --- updated-dependencies: - dependency-name: golang.org/x/net dependency-type: indirect ... Signed-off-by: dependabot[bot] <support@github.com>

…rg/x/net-0.17.0 Bump golang.org/x/net from 0.8.0 to 0.17.0

* [fix] remove horizontal align * [update] command output to not be tabbed

vmarcella · 2023-10-30T17:57:27Z

@blanquicet Apologies for responding to this PR so late -- These changes look good to me. Could you sync your branch with main to resolve the merge conflicts so that I could merge this PR for you? Thanks in advance.

Signed-off-by: Jose Blanquicet <josebl@microsoft.com>

rgardler-msft and others added 30 commits May 18, 2022 15:23

Hello World created from GitHub

c6a3e49

maybe if we put it in the right directory...

2bc6d94

Update README.md

93c67e0

Update README.md

4324a25

bug fix which caused testing to fail on newer versions of bash (Azure#13

55e1315

)

Adding exit 1 back into testing. This was taken our originally for mu…

9be4e30

…lti tenancy, however we need this signal for an action to fail and block a PR (Azure#15)

[add] initial golang setup.

bc5e14c

[add] other subcommands & start laying out the engine.

a2d77b6

[add] makefile with build + run commands.

cb6d5aa

[add] markdown parsing and codeblock extraction to retrieve commands …

e2c39c2

…from the markdown codeblocks.

[update] markdown file to be passed in as a positional argument.

bca127d

[update] documentation for how to build & run IE.

d38cd3b

[add] INI parser, add command execution via bash, and handle command …

b3a7220

…outputs from the top level.

[update] reference.

4fa30cd

[update] markdown parsing to support parsing html comment blocks & ad…

1349975

…d INI initialization to ie execute.

[add] function to extract export statements from variable blocks.

bbd0b9b

[add] environment variables to bash commands.

9d1393c

[update] codeblock extraction.

46e933a

[update] codeblock parsing to tie codeblocks to their headers.

85a406f

[update] stages to be printed out before command execution.

13f151c

[add] lipgloss for tui styling.

44952a9

[add] the spinning wheel to the command execution.

662b48f

Added Quickstart for VMSS

6c2fd93

Initial review comments addressed ahead of testing the execution impa…

d732728

…ct comments.

[update] structure of the engine to be better suited for multiple sce…

7665e13

…narios.

[add] function to extract the scenario title.

4d20133

[render] title.

cf0bd20

vmarcella and others added 22 commits October 13, 2023 14:06

More minor fixes (Azure#98)

de7032b

* [update] sed statement to use single quotations to avoid expansion during variable rendering and format document. * [update] command rendering failures to be reported. * [fix] resource URIs not being found.

[fix] resource group name matching. (Azure#99)

33a771b

[add] functions to strip invalid env vars from the env state file for…

48c5ca6

… running in cloud shell. (Azure#101)

[add] quotations to all env values. (Azure#102)

fd52367

[fix] rendering of multi-line strings

41440e4

[refactor] command rendering

531f3c8

[update] go.mod

0a78c14

[update] pipeline action for azure cli sign in. (Azure#109)

6c89a08

address multiline quoted case separately

76e70fc

[add] hide value rendering behind a feature flag

fc51625

Merge pull request Azure#106 from Azure/guptar/tutorial

44150fe

Fix multi-line command rendering and disable inline rendering

[fix] subscription setting errors to be reported in the portal.

cb791f4

LAMP Fixes

2a6e0f3

VM SSH Fixes

69929c8

AKS Fixes

c6aaa7d

Merge pull request Azure#97 from Azure/dependabot/go_modules/golang.o…

28fe522

…rg/x/net-0.17.0 Bump golang.org/x/net from 0.8.0 to 0.17.0

[fix] restoration of env vars

f476afc

[refactor] rename v to value

03880d1

readme: Fix path for tutorial.md (Azure#120)

40e125e

[fix] remove horizontal align (Azure#121)

c08329c

* [fix] remove horizontal align * [update] command output to not be tabbed

blanquicet added 5 commits October 30, 2023 19:12

cmd/ie/commands: Improve usage description for test command

94727a3

Signed-off-by: Jose Blanquicet <josebl@microsoft.com>

cmd/ie/commands/root: Propagate error instead of exiting

5e116e5

Signed-off-by: Jose Blanquicet <josebl@microsoft.com>

cmd/ie/commands/execute: Propagate error instead of exiting

5291a2c

Signed-off-by: Jose Blanquicet <josebl@microsoft.com>

cmd/ie/commands/test: Propagate error instead of exiting

459ffe3

Signed-off-by: Jose Blanquicet <josebl@microsoft.com>

cmd/ie/commands/to-bash: Propagate error instead of exiting

ecf041a

Signed-off-by: Jose Blanquicet <josebl@microsoft.com>

blanquicet force-pushed the jose/use-rune-instead-of-run branch from 44b9425 to ecf041a Compare October 30, 2023 18:17

vmarcella force-pushed the main branch from d576ad8 to f3124bd Compare May 21, 2024 19:34

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

cmd/ie/commands: Use `RunE` instead of `Run` to make code simpler #83

cmd/ie/commands: Use `RunE` instead of `Run` to make code simpler #83

blanquicet commented Oct 5, 2023

vmarcella commented Oct 30, 2023

cmd/ie/commands: Use RunE instead of Run to make code simpler #83

Are you sure you want to change the base?

cmd/ie/commands: Use RunE instead of Run to make code simpler #83

Conversation

blanquicet commented Oct 5, 2023

vmarcella commented Oct 30, 2023

cmd/ie/commands: Use `RunE` instead of `Run` to make code simpler #83

cmd/ie/commands: Use `RunE` instead of `Run` to make code simpler #83