Skip to content

Move most code from main file to utils. #17

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ehmatthes merged 5 commits into from
May 26, 2025
Merged

Move most code from main file to utils. #17

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
04a5317
Cli moved to separate file.
ehmatthes May 26, 2025
8018d1e
Utility function validate_target_dir().
ehmatthes May 26, 2025
9183958
Remove unused code.
ehmatthes May 26, 2025
09fcdc1
Move code for building plugin to utilities.
ehmatthes May 26, 2025
f2e8ac4
Move summary to utils.
ehmatthes May 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
194 changes: 7 additions & 187 deletions generate_plugin.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@

from utils import generator_utils
from utils.plugin_config import PluginConfig
from utils import cli

from pathlib import Path
import platform
Expand All @@ -18,206 +19,25 @@
import shlex
import shutil
import sys
import argparse


# Define CLI args.
def parse_cli():
parser = argparse.ArgumentParser(description="Plugin generator for django-simple-deploy.")
parser.add_argument(
"--target-dir",
type=str,
help="Path where the new directory will be written.",
)
args = parser.parse_args()

# If provided, make sure target_dir exists before doing anything else.
if args.target_dir:
path = Path(args.target_dir)
if not path.exists():
msg = f"The path {path.as_posix()} does not exist."
msg += "\n Please create this directory and run the plugin generator again,"
msg += "\n or choose another location to write to."
sys.exit(msg)

return args


def generate_plugin(plugin_config, args):
"""Generate a new plugin."""

# Validate the plugin_config object.
plugin_config.validate()

path_root = Path(__file__).parent

# Validate target dir.
if args.target_dir:
# If target_dir provided, make sure it exists and is safe to write to.
path = Path(args.target_dir)
if not path.exists():
msg = f"The path {path.as_posix()} does not exist."
sys.exit(msg)
path_root_new = path / plugin_config.pkg_name
if path_root_new.exists():
msg += f"\nA directory already exists at {path_root_new.as_posix()}."
msg += "\nPlease either move or rename that directory, choose a different package name,"
msg += "\n or write the new plugin to a different location."
sys.exit(msg)
else:
# Get permission to write to target directory.
# path_root = Path(__file__).parent
path_root_new = path_root.parent / plugin_config.pkg_name

if path_root_new.exists():
msg = "\nThe new repo needs to be written alongside this project,"
msg += f"\n but a directory already exists at {path_root_new.as_posix()}."
msg += "\nPlease either move or rename that directory, choose a different package name,"
msg += "\n or copy this project to a different location and try again."
sys.exit(msg)

while True:
msg = f"\nOkay to write new project at {path_root_new.as_posix()}? (yes/no) "
response = input(msg)
if response.lower() in ("yes", "y"):
break
if response.lower() in ("no", "n"):
msg = "\nOkay, feel free to copy this project to a different location and try again."
msg += "\n The new repo will be written alongside this project."
sys.exit(msg)
# Make sure it's okay to write to the target directory.
path_root_new = generator_utils.validate_target_dir(args, plugin_config, path_root)

print("\n\nThank you. Configuring plugin...")

# Define replacements dict.
# platform_name_lower = plugin_config.platform_name.lower().replace("-", "").replace("_", "").replace(".", "")
platform_name_lower = generator_utils.get_platform_name_lower(plugin_config.platform_name)

replacements = {
"{{PlatformName}}": plugin_config.platform_name,
"{{PlatformNameLower}}": platform_name_lower,
"{{PackageName}}": plugin_config.pkg_name,
"{{PluginName}}": plugin_config.pkg_name.replace("-", "_"),
"{{AutomateAllSupported}}": str(plugin_config.support_automate_all),
"{{LicenseName}}": plugin_config.license_name,
}


# --- Build out directory structure ---

# Make new plugin dir, and required directory structure.
print(f"\nMaking new directory: {path_root_new.as_posix()}")
path_root_new.mkdir()

print("Building inner directory structure...")

# Using mkdir(parents=True), only need to make most deeply nested dirs.
new_dirs = [
"developer_resources",
f"dsd_{platform_name_lower}/templates",
"tests/integration_tests/reference_files",
"tests/e2e_tests",
]

for new_dir in new_dirs:
path_new_dir = path_root_new / new_dir
print(f" Making new directory: {path_new_dir.as_posix()}")
path_new_dir.mkdir(parents=True)


# --- Copy files that don't need modification. ---

print(f"\nCopying files...")
target_files = [
".gitignore",
"developer_resources/README.md",
"dsd_platformname/__init__.py",
"tests/e2e_tests/__init__.py",
"tests/integration_tests/reference_files/.gitignore",
"tests/integration_tests/reference_files/Pipfile",
"tests/integration_tests/reference_files/pyproject.toml",
"tests/integration_tests/reference_files/requirements.txt",
"tests/integration_tests/reference_files/settings.py",
]

for target_file in target_files:
print(f" Copying file: {target_file}")
path_src = path_root / "plugin_template" / target_file
target_file_new = target_file.replace("dsd_platformname", f"dsd_{platform_name_lower}")
path_dest = path_root_new / target_file_new
shutil.copy(path_src, path_dest)

# --- Make replacements in file contents. ---

# Files that need to be parsed.
target_files = [
"pyproject.toml",
"tests/conftest.py",
"tests/integration_tests/test_platformname_config.py",
"tests/e2e_tests/utils.py",
"tests/e2e_tests/test_deployment.py",
"MANIFEST.in",
"README.md",
"CHANGELOG.md",
"LICENSE",
"dsd_platformname/platform_deployer.py",
"dsd_platformname/deploy.py",
"dsd_platformname/plugin_config.py",
"dsd_platformname/templates/dockerfile_example",
"dsd_platformname/templates/settings.py",
"dsd_platformname/deploy_messages.py",
]

print("\nCustomizing files...")
for target_file in target_files:
# Read file.
path = path_root / "plugin_template" / target_file
contents = path.read_text()

# Modify contents and write file.
for k, v in replacements.items():
contents = contents.replace(k, v)

target_file_new = target_file.replace("platformname", f"{platform_name_lower}")
path_new = path_root_new / target_file_new
path_new.write_text(contents)

msg = f" Wrote modified file: {target_file_new}"
print(msg)


# --- Make other changes.

# Remove automate_all support if needed.
if not plugin_config.support_automate_all:
print("Commenting out support for --automate-all...")
path = path_root_new / f"dsd_{platform_name_lower}" / "deploy_messages.py"
lines = path.read_text().splitlines()
new_lines = []
for line_num, line in enumerate(lines):
if line_num in (9,10,11,12,13,14,15, 77,78,79,80,81,82,83,84,85,86,87,88,89,90,91,92,93,94,95):
new_lines.append(f"# {line}")
else:
new_lines.append(line)

new_contents = "\n".join(new_lines)
path.write_text(new_contents)

msg = "\nFinished setting up your plugin. If there are any issues,"
msg += "\nplease delete the new plugin and try again, or make manual changes"
msg += "\nand file an issue on this project's repo:"
msg += "\n https://github.com/django-simple-deploy/dsd-plugin-template/issues"
print(msg)

msg = "\nYou should now be able to make an editable install of this project into"
msg += "\na development version of django-simple-deploy, and all initial tests"
msg += "\nshould pass."
print(msg)
generator_utils.build_new_plugin(plugin_config, path_root, path_root_new, platform_name_lower)
generator_utils.show_summary()


if __name__ == "__main__":
args = parse_cli()

# Define empty PlugingConfig object, get required info, and generate plugin.
# Parse cli, get required info, and generate plugin.
args = cli.parse_cli()
plugin_config = PluginConfig
generator_utils.get_plugin_info(plugin_config)

Expand Down
26 changes: 26 additions & 0 deletions utils/cli.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
"""Define CLI for dsd-plugin-genrator."""

import argparse
from pathlib import Path
import sys


def parse_cli():
parser = argparse.ArgumentParser(description="Plugin generator for django-simple-deploy.")
parser.add_argument(
"--target-dir",
type=str,
help="Path where the new directory will be written.",
)
args = parser.parse_args()

# If provided, make sure target_dir exists before doing anything else.
if args.target_dir:
path = Path(args.target_dir)
if not path.exists():
msg = f"The path {path.as_posix()} does not exist."
msg += "\n Please create this directory and run the plugin generator again,"
msg += "\n or choose another location to write to."
sys.exit(msg)

return args
Loading