Write tests

[ehmatthes]

This is a critical project for django-simple-deploy to have the full utility it should. Tests are critical to make sure that this package keeps up with changes in dsd core.

Tasks

• Write integration tests for current functionality. Make a temp dir in pytest, and write the new plugin to that dir. Then compare to reference project.
  • Make project testable, ie don't require the interactive session.
  • Add a --target-dir flag.
  • Implement a way for an external script (test function) to define the plugin_config object.
  • Write initial tests.
    • Configure pytest to only run actual tests for the generator, not new plugin tests.
    • Pull target_dir into plugin_config? (not needed, mock args object.
    • Make sure test can fail. (Modify deeply nested file in reference_files, make sure fails.)
• Fix issue with interpolation in deploy.py.
• Fix issue with space in platform name.
• Write e2e tests. These build a development env for dsd core, build a new plugin, install the plugin, and make sure the initial set of tests pass.
• Write validation code for PluginConfig.
• Restructure project so template is in a single directory, and generator code is in the main part of the repo.
• Update tests.
• Include a changelog, being clear about which version of this project matches which version of dsd. Also, start tagging releases to match specific versions of core.
• Start a pyproject.toml, even though this probably won't be released as a package. (No real need for this currently.)
• Update instructions in core to show how to quickly get a new plugin up and running.
  • git clone ... depth 1, don't need full history of this project in order to make a new plugin.
  • Link to this from this readme.
  • Link to this from home page of dsd docs.
  • Include links to specific lines and sections of files in plugin_template/ files.
• Set up CI for integration tests.

[ehmatthes]

Tests to write

• Test new plugin directory already exists. (should fail with appropriate message) (moved to Parking lot #2)
• Test actual CLI usage. See fix(generate_plugin.py): instantiate PluginConfig object when assigning to plugin_config #21.

[ehmatthes]

Cleanup

• Document CLI args for this project.
• Write some maintenance docs, ie how to keep this up to date with core.
• Note that e2e tests take a long time to run; may want to skip e2e tests: pytest --ignore actual_tests/e2e_tests for most development work.
• Refactor main file.
  • Refactor to a cli.py file.
• Prompt for the location where the new plugin will be written to? (with default shown?)
  • If this, remove the CLI arg?
  • Simplify validation logic
  • Reconsider where validation is called from
  • If using prompt-toolkit to support tab-completion for path, can no longer just download or clone to run this. Will have to set up a venv and then run main file.

[ehmatthes]

E2e tests

• Write the happy test path.
• Expect uv for running e2e test.
• Sort out pipenv issue. It's installed to temp env through dsd core dev requirements, but is failing the test in core that checks for availability. (It was a separate issue of not running the plugin tests. shell=True, cmd vs cmd_parts, etc.)
  • Either sort availability in temp env, or complete issue in core that skips pipenv tests if it's not available. (Same for poetry.)
  • Require it in this project for now?
• Add e2e test for 2nd plugin, in same test. Just like the workflow I've been using. Should not take much longer, after all the setup.
• Skip e2e tests for a bare pytest call.

[ehmatthes]

Restructure to plugin_template/ dir

• Restructure so tests pass.
• Simplify README logic.
• Write a main README.
• Rename actual_tests/ -> tests/.

[ehmatthes]

Set up CI

• Push directly to main, to prompt a CI run until it's configured correctly.

[ehmatthes]

Refactoring

• Finish cleaning up main file.
  • Move path logic out of main and into util functions
  • Move platform_name_lower logic out of main
  • Check imports
• Skim utils for any obvious refactoring. (Take care of this when implementing prompt for target dir.)
• Speed up e2e tests (~26-28s)
  • Don't clone full dsd repo, only latest commit. (~1s)
  • Don't run all dsd tests, just run the plugin's integration tests. (Tests run in ~12s now, >50% speedup.)
  • Implement a flag --include-core-tests, so the full set of core tests can be run against new plugins.
  • Document this flag.
  • Include this flag in CI tests.
  • Refactor e2e tests.
  • Number of passing tests should be conditional on whether core tests were included.
  • Merge

[ehmatthes]

All open tasks moved to #2.