-
Notifications
You must be signed in to change notification settings - Fork 0
refactor: ♻️ move copier test to own file #156
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.
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
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -49,60 +49,7 @@ check-spelling: | |
|
|
||
| # Test that a Python package can be created from the template, with parameters for: `is_seedcase_project` (true or false) and `hosting_provider` (either "gh-pages" or "netlify") | ||
| test is_seedcase_project="true" hosting_provider="netlify": | ||
| #!/usr/bin/env bash | ||
| test_name="test-package-{{ hosting_provider }}" | ||
| test_dir="$(pwd)/_temp/{{ is_seedcase_project }}/$test_name" | ||
| template_dir="$(pwd)" | ||
| commit=$(git rev-parse HEAD) | ||
| rm -rf $test_dir | ||
| # vcs-ref means the current commit/head, not a tag. | ||
| uvx copier copy $template_dir $test_dir \ | ||
| --vcs-ref=$commit \ | ||
| --defaults \ | ||
| --trust \ | ||
| --data is_seedcase_project={{ is_seedcase_project }} \ | ||
| --data hosting_provider={{ hosting_provider }} \ | ||
| --data github_user="first-last" \ | ||
| --data author_given_name="First" \ | ||
| --data author_family_name="Last" \ | ||
| --data author_email="[email protected]" \ | ||
| --data review_team="@first-last/developers" \ | ||
| --data github_board_number=22 | ||
| # Run checks in the generated test Python package | ||
| cd $test_dir | ||
| git add . | ||
| git commit -m "test: initial copy" | ||
| just check-python check-spelling | ||
| # TODO: Find some way to test the `update` command | ||
| # Check that recopy works | ||
| echo "Testing recopy command -----------" | ||
| rm .cz.toml | ||
| git add . | ||
| git commit -m "test: preparing to recopy from the template" | ||
| uvx copier recopy \ | ||
| --vcs-ref=$commit \ | ||
| --defaults \ | ||
| --overwrite \ | ||
| --trust | ||
| # Check that copying onto an existing Python package works | ||
| echo "Using the template in an existing package command -----------" | ||
| rm .cz.toml .copier-answers.yml LICENSE.md | ||
| git add . | ||
| git commit -m "test: preparing to copy onto an existing package" | ||
| uvx copier copy \ | ||
| $template_dir $test_dir \ | ||
| --vcs-ref=$commit \ | ||
| --defaults \ | ||
| --trust \ | ||
| --overwrite \ | ||
| --data is_seedcase_project={{ is_seedcase_project }} \ | ||
| --data hosting_provider={{ hosting_provider }} \ | ||
| --data github_user="first-last" \ | ||
| --data author_given_name="First" \ | ||
| --data author_family_name="Last" \ | ||
| --data author_email="[email protected]" \ | ||
| --data review_team="@first-last/developers" \ | ||
| --data github_board_number=22 | ||
| sh ./test-template.sh {{ is_seedcase_project }} {{ hosting_provider }} | ||
|
|
||
| # Clean up any leftover and temporary build files | ||
| cleanup: | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,82 @@ | ||
| #!/usr/bin/env bash | ||
|
|
||
| # Needs two arguments: | ||
| # | ||
| # 1. is_seedcase_project: true or false | ||
| # 2. hosting_provider: e.g., "github", "gitlab", etc. | ||
|
|
||
| # Argument naming ----- | ||
| is_seedcase_project="${1}" | ||
| hosting_provider="${2}" | ||
|
|
||
| if [ -z "$is_seedcase_project" ] || [ -z "$hosting_provider" ]; then | ||
| echo "Usage: sh $0 <is_seedcase_project> <hosting_provider>" | ||
| echo "Example: sh $0 true netlify" | ||
| exit 1 | ||
| fi | ||
|
|
||
| # Set up variables and functions for the test ----- | ||
| test_name="test-package-$hosting_provider" | ||
| test_dir="$(pwd)/_temp/$is_seedcase_project/$test_name" | ||
| template_dir="$(pwd)" | ||
| # Use the latest commit for the template | ||
| commit=$(git rev-parse HEAD) | ||
|
|
||
| # Needs three arguments: | ||
| # | ||
| # 1. Template directory | ||
| # 2. Destination directory | ||
| # 3. VCS ref (commit, branch, tag, etc.) | ||
| copy () { | ||
| # vcs-ref means the current commit/head, not a tag. | ||
| uvx copier copy $1 $2 \ | ||
| --vcs-ref=$3 \ | ||
| --defaults \ | ||
| --data is_seedcase_project=$is_seedcase_project \ | ||
| --data github_user="first-last" \ | ||
| --data hosting_provider=$hosting_provider \ | ||
| --data author_given_name="First" \ | ||
| --data author_family_name="Last" \ | ||
| --data author_email="[email protected]" \ | ||
| --data review_team="@first-last/developers" \ | ||
| --data github_board_number=22 \ | ||
| --overwrite \ | ||
| --skip-tasks \ | ||
| --trust | ||
| } | ||
|
|
||
| # Pre-test setup ----- | ||
| # Remove the leftover directory from previous runs | ||
| rm -rf $test_dir | ||
| mkdir -p $test_dir | ||
|
|
||
| # Check initial creation ----- | ||
| # TODO: Find some way to test the `update` command | ||
| # Any step that fails will exit the script with an error and not continue | ||
| echo "Testing copy for new projects when: 'is_seedcase_project'='$is_seedcase_project', 'hosting_provider'='$hosting_provider' -----------" | ||
| ( | ||
| cd $test_dir && | ||
| copy $template_dir $test_dir $commit && | ||
| git init -b main && | ||
| git add . && | ||
| git commit --quiet -m "test: initial copy" && | ||
| # Check that recopy works ----- | ||
| echo "Testing recopy when: 'is_seedcase_project'='$$is_seedcase_project', 'hosting_provider'='$hosting_provider' -----------" && | ||
| rm .cz.toml && | ||
| git add . && | ||
| git commit --quiet -m "test: preparing to recopy from the template" && | ||
| uvx copier recopy \ | ||
| --vcs-ref=$commit \ | ||
| --defaults \ | ||
| --overwrite \ | ||
| --skip-tasks \ | ||
| --trust && | ||
| # Check that copying onto an existing package works ----- | ||
| echo "Testing copy in existing projects when: 'is_seedcase_project'='$is_seedcase_project', 'hosting_provider'='$hosting_provider' -----------" && | ||
| rm .cz.toml .copier-answers.yml && | ||
| git add . && | ||
| git commit --quiet -m "test: preparing to copy onto an existing package" && | ||
| copy $template_dir $test_dir $commit #&& | ||
| # Checks and builds ----- | ||
| # just run-all | ||
| ) | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not sure if we want to run all recipes?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yea, I think I agree. Plus it will install a bunch of stuff on the workflow CI that isn't really necessary.