dir_with_hooks() - Code Metrics - Inspection of "Update HISTORY.rst with #782" - michaeljoseph/cookiecutter - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 2d0aff...454794 )

by Michael

created 2016-08-20 19:34 UTC

dir_with_hooks() B

↳ Parent: Project

Complexity

Conditions

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	1
c	1
b	0
f	0
dl	0
loc	33
rs	8.8571

# -*- coding: utf-8 -*-

"""
test_hooks
------------

Tests for `cookiecutter.hooks` module.
"""

import os
import pytest
import stat
import sys
import textwrap

from cookiecutter import hooks, utils, exceptions


def make_test_repo(name):
    """Helper function which is called in the test setup methods."""
    hook_dir = os.path.join(name, 'hooks')
    template = os.path.join(name, 'input{{hooks}}')
    os.mkdir(name)
    os.mkdir(hook_dir)
    os.mkdir(template)

    with open(os.path.join(template, 'README.rst'), 'w') as f:
        f.write("foo\n===\n\nbar\n")

    with open(os.path.join(hook_dir, 'pre_gen_project.py'), 'w') as f:
        f.write("#!/usr/bin/env python\n")
        f.write("# -*- coding: utf-8 -*-\n")
        f.write("from __future__ import print_function\n")
        f.write("\n")
        f.write("print('pre generation hook')\n")
        f.write("f = open('python_pre.txt', 'w')\n")
        f.write("f.close()\n")

    if sys.platform.startswith('win'):

        post = 'post_gen_project.bat'
        with open(os.path.join(hook_dir, post), 'w') as f:
            f.write("@echo off\n")
            f.write("\n")
            f.write("echo post generation hook\n")
            f.write("echo. >shell_post.txt\n")
    else:
        post = 'post_gen_project.sh'
        filename = os.path.join(hook_dir, post)
        with open(filename, 'w') as f:
            f.write("#!/bin/bash\n")
            f.write("\n")
            f.write("echo 'post generation hook';\n")
            f.write("touch 'shell_post.txt'\n")
        # Set the execute bit
        os.chmod(filename, os.stat(filename).st_mode | stat.S_IXUSR)

    return post


class TestFindHooks(object):

    repo_path = 'tests/test-hooks'

    def setup_method(self, method):
        self.post_hook = make_test_repo(self.repo_path)

    def teardown_method(self, method):
        utils.rmtree(self.repo_path)

    def test_find_hook(self):
        """Finds the specified hook."""

        with utils.work_in(self.repo_path):
            expected = {
                'pre_gen_project': os.path.abspath('hooks/pre_gen_project.py'),
                'post_gen_project': os.path.abspath(
                    os.path.join('hooks', self.post_hook)
                ),
            }
            assert expected == hooks.find_hooks()

    def test_no_hooks(self):
        """find_hooks should return None if the hook could not be found."""

        with utils.work_in('tests/fake-repo'):
            assert {} == hooks.find_hooks()


class TestExternalHooks(object):

    repo_path = os.path.abspath('tests/test-hooks/')
    hooks_path = os.path.abspath('tests/test-hooks/hooks')

    def setup_method(self, method):
        self.post_hook = make_test_repo(self.repo_path)

    def teardown_method(self, method):
        utils.rmtree(self.repo_path)

        if os.path.exists('python_pre.txt'):
            os.remove('python_pre.txt')
        if os.path.exists('shell_post.txt'):
            os.remove('shell_post.txt')
        if os.path.exists('tests/shell_post.txt'):
            os.remove('tests/shell_post.txt')
        if os.path.exists('tests/test-hooks/input{{hooks}}/python_pre.txt'):
            os.remove('tests/test-hooks/input{{hooks}}/python_pre.txt')
        if os.path.exists('tests/test-hooks/input{{hooks}}/shell_post.txt'):
            os.remove('tests/test-hooks/input{{hooks}}/shell_post.txt')
        if os.path.exists('tests/context_post.txt'):
            os.remove('tests/context_post.txt')

    def test_run_script(self):
        """Execute a hook script, independently of project generation"""
        hooks.run_script(os.path.join(self.hooks_path, self.post_hook))
        assert os.path.isfile('shell_post.txt')

    def test_run_script_cwd(self):
        """Change directory before running hook"""
        hooks.run_script(
            os.path.join(self.hooks_path, self.post_hook),
            'tests'
        )
        assert os.path.isfile('tests/shell_post.txt')
        assert 'tests' not in os.getcwd()

    def test_run_script_with_context(self):
        """Execute a hook script, passing a context"""

        hook_path = os.path.join(self.hooks_path, 'post_gen_project.sh')

        if sys.platform.startswith('win'):

            post = 'post_gen_project.bat'
            with open(os.path.join(self.hooks_path, post), 'w') as f:
                f.write("@echo off\n")
                f.write("\n")
                f.write("echo post generation hook\n")
                f.write("echo. >{{cookiecutter.file}}\n")
        else:
            with open(hook_path, 'w') as fh:
                fh.write("#!/bin/bash\n")
                fh.write("\n")
                fh.write("echo 'post generation hook';\n")
                fh.write("touch 'shell_post.txt'\n")
                fh.write("touch '{{cookiecutter.file}}'\n")
                os.chmod(hook_path, os.stat(hook_path).st_mode | stat.S_IXUSR)

        hooks.run_script_with_context(
            os.path.join(self.hooks_path, self.post_hook),
            'tests',
            {
                'cookiecutter': {
                    'file': 'context_post.txt'
                }
            })
        assert os.path.isfile('tests/context_post.txt')
        assert 'tests' not in os.getcwd()

    def test_run_hook(self):
        """Execute hook from specified template in specified output
        directory.
        """
        tests_dir = os.path.join(self.repo_path, 'input{{hooks}}')
        with utils.work_in(self.repo_path):
            hooks.run_hook('pre_gen_project', tests_dir, {})
            assert os.path.isfile(os.path.join(tests_dir, 'python_pre.txt'))

            hooks.run_hook('post_gen_project', tests_dir, {})
            assert os.path.isfile(os.path.join(tests_dir, 'shell_post.txt'))

    def test_run_failing_hook(self):
        hook_path = os.path.join(self.hooks_path, 'pre_gen_project.py')
        tests_dir = os.path.join(self.repo_path, 'input{{hooks}}')

        with open(hook_path, 'w') as f:
            f.write("#!/usr/bin/env python\n")
            f.write("import sys; sys.exit(1)\n")

        with utils.work_in(self.repo_path):
            with pytest.raises(exceptions.FailedHookException) as excinfo:
                hooks.run_hook('pre_gen_project', tests_dir, {})
            assert 'Hook script failed' in str(excinfo.value)


@pytest.yield_fixture
def dir_with_hooks(tmpdir):
    """Yield a directory that contains hook backup files."""

    hooks_dir = tmpdir.mkdir('hooks')

    pre_hook_content = textwrap.dedent(
        u"""
        #!/usr/bin/env python
        # -*- coding: utf-8 -*-
        print('pre_gen_project.py~')
        """
    )
    pre_gen_hook_file = hooks_dir / 'pre_gen_project.py~'
    pre_gen_hook_file.write_text(pre_hook_content, encoding='utf8')

    post_hook_content = textwrap.dedent(
        u"""
        #!/usr/bin/env python
        # -*- coding: utf-8 -*-
        print('post_gen_project.py~')
        """
    )

    post_gen_hook_file = hooks_dir / 'post_gen_project.py~'
    post_gen_hook_file.write_text(post_hook_content, encoding='utf8')

    # Make sure to yield the parent directory as `find_hooks()`
    # looks into `hooks/` in the current working directory
    yield str(tmpdir)

    pre_gen_hook_file.remove()
    post_gen_hook_file.remove()


def test_ignore_hook_backup_files(monkeypatch, dir_with_hooks):
    # Change the current working directory that contains `hooks/`
    monkeypatch.chdir(dir_with_hooks)
    assert hooks.find_hooks() == {}


1		# -- coding: utf-8 --
2
3		"""
4		test_hooks
5		------------
6
7		Tests for `cookiecutter.hooks` module.
8		"""
9
10		import os
11		import pytest
12		import stat
13		import sys
14		import textwrap
15
16		from cookiecutter import hooks, utils, exceptions
17
18
19		def make_test_repo(name):
20		"""Helper function which is called in the test setup methods."""
21		hook_dir = os.path.join(name, 'hooks')
22		template = os.path.join(name, 'input{{hooks}}')
23		os.mkdir(name)
24		os.mkdir(hook_dir)
25		os.mkdir(template)
26
27		with open(os.path.join(template, 'README.rst'), 'w') as f:
28		f.write("foo\n===\n\nbar\n")
29
30		with open(os.path.join(hook_dir, 'pre_gen_project.py'), 'w') as f:
31		f.write("#!/usr/bin/env python\n")
32		f.write("# -- coding: utf-8 --\n")
33		f.write("from __future__ import print_function\n")
34		f.write("\n")
35		f.write("print('pre generation hook')\n")
36		f.write("f = open('python_pre.txt', 'w')\n")
37		f.write("f.close()\n")
38
39	View Code Duplication	if sys.platform.startswith('win'):
		0 ignored issues – show Duplication introduced 2016-04-28 13:13 UTC by Report Bug Copy Issue Report This code seems to be duplicated in your project. Loading history...
40		post = 'post_gen_project.bat'
41		with open(os.path.join(hook_dir, post), 'w') as f:
42		f.write("@echo off\n")
43		f.write("\n")
44		f.write("echo post generation hook\n")
45		f.write("echo. >shell_post.txt\n")
46		else:
47		post = 'post_gen_project.sh'
48		filename = os.path.join(hook_dir, post)
49		with open(filename, 'w') as f:
50		f.write("#!/bin/bash\n")
51		f.write("\n")
52		f.write("echo 'post generation hook';\n")
53		f.write("touch 'shell_post.txt'\n")
54		# Set the execute bit
55		os.chmod(filename, os.stat(filename).st_mode \| stat.S_IXUSR)
56
57		return post
58
59
60		class TestFindHooks(object):
61
62		repo_path = 'tests/test-hooks'
63
64		def setup_method(self, method):
65		self.post_hook = make_test_repo(self.repo_path)
66
67		def teardown_method(self, method):
68		utils.rmtree(self.repo_path)
69
70		def test_find_hook(self):
71		"""Finds the specified hook."""
72
73		with utils.work_in(self.repo_path):
74		expected = {
75		'pre_gen_project': os.path.abspath('hooks/pre_gen_project.py'),
76		'post_gen_project': os.path.abspath(
77		os.path.join('hooks', self.post_hook)
78		),
79		}
80		assert expected == hooks.find_hooks()
81
82		def test_no_hooks(self):
83		"""find_hooks should return None if the hook could not be found."""
84
85		with utils.work_in('tests/fake-repo'):
86		assert {} == hooks.find_hooks()
87
88
89		class TestExternalHooks(object):
90
91		repo_path = os.path.abspath('tests/test-hooks/')
92		hooks_path = os.path.abspath('tests/test-hooks/hooks')
93
94		def setup_method(self, method):
95		self.post_hook = make_test_repo(self.repo_path)
96
97		def teardown_method(self, method):
98		utils.rmtree(self.repo_path)
99
100		if os.path.exists('python_pre.txt'):
101		os.remove('python_pre.txt')
102		if os.path.exists('shell_post.txt'):
103		os.remove('shell_post.txt')
104		if os.path.exists('tests/shell_post.txt'):
105		os.remove('tests/shell_post.txt')
106		if os.path.exists('tests/test-hooks/input{{hooks}}/python_pre.txt'):
107		os.remove('tests/test-hooks/input{{hooks}}/python_pre.txt')
108		if os.path.exists('tests/test-hooks/input{{hooks}}/shell_post.txt'):
109		os.remove('tests/test-hooks/input{{hooks}}/shell_post.txt')
110		if os.path.exists('tests/context_post.txt'):
111		os.remove('tests/context_post.txt')
112
113		def test_run_script(self):
114		"""Execute a hook script, independently of project generation"""
115		hooks.run_script(os.path.join(self.hooks_path, self.post_hook))
116		assert os.path.isfile('shell_post.txt')
117
118		def test_run_script_cwd(self):
119		"""Change directory before running hook"""
120		hooks.run_script(
121		os.path.join(self.hooks_path, self.post_hook),
122		'tests'
123		)
124		assert os.path.isfile('tests/shell_post.txt')
125		assert 'tests' not in os.getcwd()
126
127		def test_run_script_with_context(self):
128		"""Execute a hook script, passing a context"""
129
130		hook_path = os.path.join(self.hooks_path, 'post_gen_project.sh')
131
132	View Code Duplication	if sys.platform.startswith('win'):
		0 ignored issues – show Duplication introduced 2016-04-28 13:13 UTC by Report Bug Copy Issue Report This code seems to be duplicated in your project. Loading history...
133		post = 'post_gen_project.bat'
134		with open(os.path.join(self.hooks_path, post), 'w') as f:
135		f.write("@echo off\n")
136		f.write("\n")
137		f.write("echo post generation hook\n")
138		f.write("echo. >{{cookiecutter.file}}\n")
139		else:
140		with open(hook_path, 'w') as fh:
141		fh.write("#!/bin/bash\n")
142		fh.write("\n")
143		fh.write("echo 'post generation hook';\n")
144		fh.write("touch 'shell_post.txt'\n")
145		fh.write("touch '{{cookiecutter.file}}'\n")
146		os.chmod(hook_path, os.stat(hook_path).st_mode \| stat.S_IXUSR)
147
148		hooks.run_script_with_context(
149		os.path.join(self.hooks_path, self.post_hook),
150		'tests',
151		{
152		'cookiecutter': {
153		'file': 'context_post.txt'
154		}
155		})
156		assert os.path.isfile('tests/context_post.txt')
157		assert 'tests' not in os.getcwd()
158
159		def test_run_hook(self):
160		"""Execute hook from specified template in specified output
161		directory.
162		"""
163		tests_dir = os.path.join(self.repo_path, 'input{{hooks}}')
164		with utils.work_in(self.repo_path):
165		hooks.run_hook('pre_gen_project', tests_dir, {})
166		assert os.path.isfile(os.path.join(tests_dir, 'python_pre.txt'))
167
168		hooks.run_hook('post_gen_project', tests_dir, {})
169		assert os.path.isfile(os.path.join(tests_dir, 'shell_post.txt'))
170
171		def test_run_failing_hook(self):
172		hook_path = os.path.join(self.hooks_path, 'pre_gen_project.py')
173		tests_dir = os.path.join(self.repo_path, 'input{{hooks}}')
174
175		with open(hook_path, 'w') as f:
176		f.write("#!/usr/bin/env python\n")
177		f.write("import sys; sys.exit(1)\n")
178
179		with utils.work_in(self.repo_path):
180		with pytest.raises(exceptions.FailedHookException) as excinfo:
181		hooks.run_hook('pre_gen_project', tests_dir, {})
182		assert 'Hook script failed' in str(excinfo.value)
183
184
185		@pytest.yield_fixture
186		def dir_with_hooks(tmpdir):
187		"""Yield a directory that contains hook backup files."""
188
189		hooks_dir = tmpdir.mkdir('hooks')
190
191		pre_hook_content = textwrap.dedent(
192		u"""
193		#!/usr/bin/env python
194		# -- coding: utf-8 --
195		print('pre_gen_project.py~')
196		"""
197		)
198		pre_gen_hook_file = hooks_dir / 'pre_gen_project.py~'
199		pre_gen_hook_file.write_text(pre_hook_content, encoding='utf8')
200
201		post_hook_content = textwrap.dedent(
202		u"""
203		#!/usr/bin/env python
204		# -- coding: utf-8 --
205		print('post_gen_project.py~')
206		"""
207		)
208
209		post_gen_hook_file = hooks_dir / 'post_gen_project.py~'
210		post_gen_hook_file.write_text(post_hook_content, encoding='utf8')
211
212		# Make sure to yield the parent directory as `find_hooks()`
213		# looks into `hooks/` in the current working directory
214		yield str(tmpdir)
215
216		pre_gen_hook_file.remove()
217		post_gen_hook_file.remove()
218
219
220		def test_ignore_hook_backup_files(monkeypatch, dir_with_hooks):
221		# Change the current working directory that contains `hooks/`
222		monkeypatch.chdir(dir_with_hooks)
223		assert hooks.find_hooks() == {}
224

michaeljoseph / cookiecutter

Push — master ( 2d0aff...454794 )

dir_with_hooks() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like