mirror of
https://github.com/cookiecutter/cookiecutter-django.git
synced 2024-09-21 03:19:07 +03:00
6e72169ffe
* Add failing test for travis.yml I see three options to test travis.yml : 1. Testing that the YAML contains relevant value. Least useful and least reliable, but simplest to implement. 2. Testing that the YAML is valid TravisCI YAML. Unfortunately this is difficult / impossible. Doing 'travis lint' would succeed, this command does not check for 'script' key presence and wouldn't be useful for us. We could use 'travis-build' to verify that the YAML can be converted to a worker config, but as of now 'travis-build' doesn't work out of the box. There is a new tool for validating travis YAML files 'travis-yml', but as of now it's a ruby-only library and it's still a work in progress. 3. Running Travis CI task based on the generated YAML. This seems the best approach, however since cookiecutter-django itself uses Travis CI, that would require running Travis CI from within Travis CI. Scheduling Travis CI job without a github push still requires a public github repo, which is something that we can't generate on demand. Given that I'm opting to use approach 1. * Adds missing config to generated .travis.yml The keys added are as follows: 1. 'script' Required by Travis, cookiecutter-django used to provide it until it has been removed together with hitch. I'm assuming hitch has been replaced with pytest, I'm setting pytest as the new value for the 'script' key. 2. 'install' Not required by Travis, but necessary in our case; installs test libraries, mostly pytest. As of now this points to 'local.txt' requirements file. There used to be a separate 'test.txt' requirements file but it has been decided to merge it with 'local.txt', see discussion in https://github.com/pydanny/cookiecutter-django/pull/1557 . * Update CONTRIBUTORS.rst
105 lines
2.8 KiB
Python
Executable File
105 lines
2.8 KiB
Python
Executable File
import os
|
|
import re
|
|
import sh
|
|
import yaml
|
|
|
|
import pytest
|
|
from binaryornot.check import is_binary
|
|
|
|
PATTERN = "{{(\s?cookiecutter)[.](.*?)}}"
|
|
RE_OBJ = re.compile(PATTERN)
|
|
|
|
|
|
@pytest.fixture
|
|
def context():
|
|
return {
|
|
"project_name": "My Test Project",
|
|
"project_slug": "my_test_project",
|
|
"author_name": "Test Author",
|
|
"email": "test@example.com",
|
|
"description": "A short description of the project.",
|
|
"domain_name": "example.com",
|
|
"version": "0.1.0",
|
|
"timezone": "UTC",
|
|
}
|
|
|
|
|
|
def build_files_list(root_dir):
|
|
"""Build a list containing absolute paths to the generated files."""
|
|
return [
|
|
os.path.join(dirpath, file_path)
|
|
for dirpath, subdirs, files in os.walk(root_dir)
|
|
for file_path in files
|
|
]
|
|
|
|
|
|
def check_paths(paths):
|
|
"""Method to check all paths have correct substitutions,
|
|
used by other tests cases
|
|
"""
|
|
# Assert that no match is found in any of the files
|
|
for path in paths:
|
|
if is_binary(path):
|
|
continue
|
|
|
|
for line in open(path, "r"):
|
|
match = RE_OBJ.search(line)
|
|
msg = "cookiecutter variable not replaced in {}"
|
|
assert match is None, msg.format(path)
|
|
|
|
|
|
def test_default_configuration(cookies, context):
|
|
result = cookies.bake(extra_context=context)
|
|
assert result.exit_code == 0
|
|
assert result.exception is None
|
|
assert result.project.basename == context["project_slug"]
|
|
assert result.project.isdir()
|
|
|
|
paths = build_files_list(str(result.project))
|
|
assert paths
|
|
check_paths(paths)
|
|
|
|
|
|
@pytest.fixture(params=["use_mailhog", "use_celery", "windows"])
|
|
def feature_context(request, context):
|
|
context.update({request.param: "y"})
|
|
return context
|
|
|
|
|
|
def test_enabled_features(cookies, feature_context):
|
|
result = cookies.bake(extra_context=feature_context)
|
|
assert result.exit_code == 0
|
|
assert result.exception is None
|
|
assert result.project.basename == feature_context["project_slug"]
|
|
assert result.project.isdir()
|
|
|
|
paths = build_files_list(str(result.project))
|
|
assert paths
|
|
check_paths(paths)
|
|
|
|
|
|
def test_flake8_compliance(cookies):
|
|
"""generated project should pass flake8"""
|
|
result = cookies.bake()
|
|
|
|
try:
|
|
sh.flake8(str(result.project))
|
|
except sh.ErrorReturnCode as e:
|
|
pytest.fail(e)
|
|
|
|
|
|
def test_travis_invokes_pytest(cookies, context):
|
|
context.update({"use_travisci": "y"})
|
|
result = cookies.bake(extra_context=context)
|
|
|
|
assert result.exit_code == 0
|
|
assert result.exception is None
|
|
assert result.project.basename == context["project_slug"]
|
|
assert result.project.isdir()
|
|
|
|
with open(f'{result.project}/.travis.yml', 'r') as travis_yml:
|
|
try:
|
|
assert yaml.load(travis_yml)['script'] == ['pytest']
|
|
except yaml.YAMLError as e:
|
|
pytest.fail(e)
|