dsd-plugin-generator

This is a tool for generating new plugins for django-simple-deploy. When you run the generator, you get a full plugin with a set of starting tests, and you get to focus on the deployment-specific code that's unique to your plugin.

Usage notes

• Clone (or download) this repo.
• Run python generate_plugin.py, and answer the small set of prompts:

$ python generate_plugin.py 
What platform are you targeting? (Example: Fly.io) CodeRed
What's the name of your plugin package? (Example: dsd-flyio) dsd-codered
Will your plugin support the --automate-all CLI arg? (yes/no) yes
What name do you want to appear in the LICENSE file? Eric Matthes

Here's the information you've provided:
  Platform name: CodeRed
  Package name: dsd-codered
  Supports --automate-all: True
  Name on license: Eric Matthes

Is this information correct? (yes/no) y

Okay to write new project at /Users/eric/projects/dsd-codered? (yes/no) y


Thank you. Configuring plugin...
...

• Most files are filled in for you based on the information you provide.
• Before making any changes to the new plugin, make an editable install of the new plugin in a django-simple-deploy development environment, and run the tests. All initial tests should pass:

(django-simple-deploy) ~/projects/django-simple-deploy$ uv pip install -e ~/projects/dsd-codered
Resolved 12 packages in 5ms
Installed 1 package in 1ms
 + dsd-codered==0.1.0 (from file:///Users/eric/projects/dsd-codered)
(django-simple-deploy) ~/projects/django-simple-deploy$ pytest
=============================== test session starts ===============================
platform darwin -- Python 3.12.2, pytest-8.3.3, pluggy-1.5.0
rootdir: /Users/eric/projects/django-simple-deploy
configfile: pyproject.toml
collected 71 items

tests/integration_tests/platform_agnostic_tests/test_found_existing_file.py sss
tests/integration_tests/platform_agnostic_tests/test_git_status_checks.py .............
tests/integration_tests/platform_agnostic_tests/test_project_inspection.py sss
tests/integration_tests/platform_agnostic_tests/test_valid_cli_commands.py ...
tests/unit_tests/test_deploy_messages.py ...
tests/unit_tests/test_git_status_utils.py ...........
tests/unit_tests/test_utils.py .................
test_codered_config.py ..................

=============================== 65 passed, 6 skipped in 9.11s ===============================

• Fill out the messages in deploy_messages.py.
• Write methods in platform_deployer.py to carry out configuration for the target platform.
• For more information about writing a plugin, see the Plugins section of the django-simple-deploy documentation.

Development notes

Testing

Currently, unit and integration tests finish in well under 1 second. End to end tests take almost 30s. For efficiency, a bare pytest call only runs unit and integration tests.

Integration tests run the generator and inspect the new plugin that's generated. End to end tests go much further: they make a temp environment, generate a new plugin, install a development instance of django-simple-deploy, install the new plugin, and run the initial set of tests.

To run e2e tests:

$ pytest tests/e2e_tests -s

The -s flag is not required, but since the tests takes a fairly long time it's helpful to see the output as it's running. You can get a good sense of which steps are working by watching the output as the test runs.

This will only run the integration tests for each new plugin in the e2e test. It will not run all of django-simple-deploy's tests for each new plugin. If you want to run the full set of tests, include an additional flag:

$ pytest tests/e2e_tests -s --include-core-tests

Currently, CI tests only run unit and integration tests. There's an open task in django-simple-deploy to remove the dependence on poetry and pipenv for running tests. When that is implemented, e2e tests can run much more easily in CI.

Documentation

For more information, see the docs directory.