'cache prepare' command #67
Commits on May 18, 2022
-
test: add Aruba Cucumber testing
Configures the project for BDD-based acceptance testing with Aruba and Cucumber.
-
...because, Freshli should be fresh, no? ;) Also updates GitHub Action tooling.
-
-
-
-
refactor: move --output and --format to scan only
Eliminates some now-unnecessary inheritance with commands, wherein all commands would include the --output and --format options. Also updates more dependencies to the latest versions.
-
-
feat: add 'cache' and 'cache prepare' commands
Implements the 'cache' command, which has a 'prepare' subcommand. At present, this does nothing.
-
feat: add global --cache-dir option
Adds a --cache-dir global option with a default value of $HOME/.freshli, for storing temporary files.
-
bug: return code from ScanCommand.Run()
The ScanCommandRunner.Run() function returns an integer return code (0 if successful), and the invocation of ScanCommand.Run() expects a return code, but ScanCommand.Run() incorrectly is 'void'. This changes the return of Run() so it no longer drops this return code.
-
feat: implement 'cache prepare' command
Creates the database file at the user-specified (or default) location for the cache, and/or migrates the existing file. If the file is corrupt, the command fails with a non-zero exit code.
-
refactor test: make VerifyAlias test helper function generic
Tests for other commands will need to use the logic in VerifyAlias. This moves VerifyAlias to a new TestHelpers class, and makes the function generic, so it can be used with any System.CommandLine.Command class.
-
test: --cache-dir global option
Tests for --cache-dir global option. This can only be tested on MainCommand directly, since the normal command building does not take place in the tests.
-
test: main command should not itself have a handler
The main command should not be runnable directly. Instead, one of its subcommands must be run instead. This test confirms that as true.
-
test: 'cache' and 'cache prepare' commands
Confirms the following: * 'cache' is not directly runnable (no handler) * 'cache prepare' is runnable (has handler)
-
Cucumber now tests more specific statements within the --help output, rather than expecting a large exact block.
-
test: testing 'cache prepare' produces valid database
Ensures that 'cache prepare' creates the expected default folder, and generates an SQLite database file that passes SQLite's "PRAGMA integrity_check". NOTE: It is not feasible to test for pending migrations with cucumber.
-
-
docs: update CONTRIBUTING.md to reflect new architecture
--format and --output are no longer shared between all commands, so all mentions of that are removed. Shows the correct inheritance for Commands now that BaseCommand<> has been removed. Adds mention of --cache-dir global argument. Documents the new cache command.
-
docs: fix various typos and formatting issues
Fixes misspelled words in README.md and CONTRIBUTING.md. Improves alignment of columns on Markdown representation of tables (thanks to JetBrains). Improves readability of command list in Program.cs, to make it easier for future developers to add their own. Reordered methods in Program.cs from outermost to innermost to make navigating the file a bit easier.
-
-
-
-
Adds in Ruby 3.1 using the same setup that's used to build the official Docker container. https://github.com/docker-library/ruby/blob/master/3.1/bullseye/Dockerfile
-
Reduces duplication within option/argument helper methods
Also changes the name of the methods to make it more clear that a value is being retrieved, not an option/argument.
-
-
-
Reduces duplication between test methods
Switches to using `MethodData` and `TheoryData` to represent the set of data to test. This approach is used instead of the `[InlineData]` attribute because the `ArgumentArity` values are not technically constants, and only constant values can be parameters to attributes.
-
fix: eliminate use of environment variable for --cache-dir
Environment variables on Linux do not persist between process executions, so this was not actually enabling the 'dotnet ef' tool to work with non-standard locations. Removing all use of the environment variable to simplify code.
-
-
-
-
-
Removes extraneous configuration
This was erroneously left over after the collect and submit steps were separated.
-
-
-
