git_repo() - Code Metrics - Inspection of "Refactor and polish" - michaeljoseph/changes - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#127)

by Michael

created 2017-11-06 22:14 UTC

git_repo() B

↳ Parent: Project

Complexity

Conditions

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes	3
Bugs	0	Features	0

Metric	Value
cc	4
c	3
b	0
f	0
dl	0
loc	22
rs	8.9197

import os
import shlex
import textwrap
from pathlib import Path

import pytest
import sys
from click.testing import CliRunner
# .scrutinizer.yml
before_commands:
    - sudo pip install abc # Python2
    - sudo pip3 install abc # Python3
from plumbum.cmd import git
# .scrutinizer.yml
before_commands:
    - sudo pip install abc # Python2
    - sudo pip3 install abc # Python3

import changes

pytest_plugins = 'pytester'


# TODO: textwrap.dedent.heredoc
INIT_CONTENT = [
    '"""A test app"""',
    '',
    "__version__ = '0.0.1'",
    "__url__ = 'https://github.com/someuser/test_app'",
    "__author__ = 'Some User'",
    "__email__ = '[email protected]'"
]
SETUP_PY = [
    'from setuptools import setup',
    "setup(name='test_app'",
]
README_MARKDOWN = [
    '# Test App',
    '',
    'This is the test application.'
]

PYTHON_MODULE = 'test_app'

PYTHON_PROJECT_CONTENT = {
    '%s/__init__.py' % PYTHON_MODULE: INIT_CONTENT,
    'setup.py': SETUP_PY,
    'requirements.txt': ['pytest'],
}

FILE_CONTENT = {
    'version.txt': ['0.0.1'],
    'README.md': README_MARKDOWN,
    'CHANGELOG.md': [''],
}

AUTH_TOKEN_ENVVAR = 'GITHUB_AUTH_TOKEN'

BUG_LABEL_JSON = [
    {
        'id': 52048163,
        'url': 'https://api.github.com/repos/michaeljoseph/changes/labels/bug',
        'name': 'bug',
        'color': 'fc2929',
        'default': True
    }
]

ISSUE_URL = 'https://api.github.com/repos/michaeljoseph/test_app/issues/111'
PULL_REQUEST_JSON = {
    'number': 111,
    'title': 'The title of the pull request',
    'body': 'An optional, longer description.',
    'user': {
        'login': 'michaeljoseph'
    },
    'labels': [
        {'id': 1, 'name': 'bug'}
    ],
}

LABEL_URL = 'https://api.github.com/repos/michaeljoseph/test_app/labels'
BUG_LABEL_JSON = [
    {
        'id': 52048163,
        'url': 'https://api.github.com/repos/michaeljoseph/test_app/labels/bug',

        'name': 'bug',
        'color': 'fc2929',
        'default': True
    }
]

RELEASES_URL = 'https://api.github.com/repos/michaeljoseph/test_app/releases'


@pytest.fixture
def git_repo(tmpdir):
    with CliRunner().isolated_filesystem() as repo_dir:
        for file_path, content in FILE_CONTENT.items():
            open(file_path, 'w').write(
                '\n'.join(content)
            )

        git('init')
        git(shlex.split('config --local user.email "[email protected]"'))
        git(shlex.split('remote add origin https://github.com/michaeljoseph/test_app.git'))


        tmp_push_repo = Path(str(tmpdir))
        git('init', '--bare', str(tmp_push_repo))
        git(shlex.split('remote set-url --push origin {}'.format(tmp_push_repo.as_uri())))


        git('add', [file for file in FILE_CONTENT.keys()])

        git('commit', '-m', 'Initial commit')
        git(shlex.split('tag 0.0.1'))

        yield repo_dir


@pytest.fixture
def python_module(git_repo):
param = 5

class Foo:
    def __init__(self, param):   # "param" would be flagged here
        self.param = param
    os.mkdir(PYTHON_MODULE)

    for file_path, content in PYTHON_PROJECT_CONTENT.items():
        open(file_path, 'w').write(
            '\n'.join(content)
        )

    git('add', [file for file in PYTHON_PROJECT_CONTENT.keys()])
    git('commit', '-m', 'Python project initialisation')

    yield


def github_merge_commit(pull_request_number):
    from haikunator import Haikunator
# .scrutinizer.yml
before_commands:
    - sudo pip install abc # Python2
    - sudo pip3 install abc # Python3

    branch_name = Haikunator().haikunate()
    commands = [
        'checkout -b {}'.format(branch_name),
        'commit --allow-empty -m "Test branch commit message"',
        'checkout master',
        'merge --no-ff {}'.format(branch_name),

        'commit --allow-empty --amend -m '
        '"Merge pull request #{} from test_app/{}"'.format(
            pull_request_number,
            branch_name,
        )
    ]
    for command in commands:
        git(shlex.split(command))


# prompts_for_tool_configuration
@pytest.fixture
def with_releases_directory_and_bumpversion_file_prompt(mocker):

    prompt = mocker.patch(
        'changes.config.click.prompt',
        autospec=True
    )
    prompt.side_effect = [
        # release_directory
        'docs/releases',
        # bumpversion files
        'version.txt',
        # quit prompt
        '.',
        # label descriptions
        # 'Features',
        # 'Bug Fixes'
    ]

    prompt = mocker.patch(
        'changes.config.prompt.choose_labels',
        autospec=True
    )
    prompt.return_value = ['bug']


@pytest.fixture
def with_auth_token_prompt(mocker):
    _ = mocker.patch('changes.config.click.launch')

    prompt = mocker.patch('changes.config.click.prompt')
    prompt.return_value = 'foo'

    saved_token = None
    if os.environ.get(AUTH_TOKEN_ENVVAR):
        saved_token = os.environ[AUTH_TOKEN_ENVVAR]
        del os.environ[AUTH_TOKEN_ENVVAR]

    yield

    if saved_token:
        os.environ[AUTH_TOKEN_ENVVAR] = saved_token


@pytest.fixture
def with_auth_token_envvar():
    saved_token = None
    if os.environ.get(AUTH_TOKEN_ENVVAR):
        saved_token = os.environ[AUTH_TOKEN_ENVVAR]

    os.environ[AUTH_TOKEN_ENVVAR] = 'foo'

    yield

    if saved_token:
        os.environ[AUTH_TOKEN_ENVVAR] = saved_token
    else:
        del os.environ[AUTH_TOKEN_ENVVAR]


@pytest.fixture
def changes_config_in_tmpdir(monkeypatch, tmpdir):
    IS_WINDOWS = 'win32' in str(sys.platform).lower()


    changes_config_file = Path(str(tmpdir.join('.changes')))
    monkeypatch.setattr(
        changes.config,
        'expandvars' if IS_WINDOWS else 'expanduser',
        lambda x: str(changes_config_file)
    )
    assert not changes_config_file.exists()
    return changes_config_file


@pytest.fixture
def configured(git_repo, changes_config_in_tmpdir):
param = 5

class Foo:
    def __init__(self, param):   # "param" would be flagged here
        self.param = param
    changes_config_in_tmpdir.write_text(textwrap.dedent(
        """\
        [changes]
        auth_token = "foo"
        """
    ))

    Path('.changes.toml').write_text(textwrap.dedent(

        """\
        [changes]
        releases_directory = "docs/releases"

        [changes.labels.bug]
        default = true
        id = 208045946
        url = "https://api.github.com/repos/michaeljoseph/test_app/labels/bug"
        name = "bug"
        description = "Bug"
        color = "f29513"
        """
    ))

    Path('.bumpversion.cfg').write_text(textwrap.dedent(

        """\
        [bumpversion]
        current_version = 0.0.1

        [bumpversion:file:version.txt]
        """
    ))

    for file_to_add in ['.changes.toml', '.bumpversion.cfg']:
        git('add', file_to_add)
    git('commit', '-m', 'Add changes configuration files')

    return str(changes_config_in_tmpdir)


Pull Request — master (#127)

git_repo() B

Complexity

Size

Duplication

Importance

1. Missing Dependencies

2. Missing init.py files

1. Missing Dependencies

2. Missing init.py files

1. Missing Dependencies

2. Missing init.py files

1			import os
2			import shlex
3			import textwrap
4			from pathlib import Path
5
6			import pytest
7			import sys
8			from click.testing import CliRunner
			0 ignored issues – show Configuration introduced 2015-11-21 13:43 UTC by Report Bug Copy Issue Report The import `click.testing` could not be resolved. This can be caused by one of the following: 1. Missing Dependencies This error could indicate a configuration issue of Pylint. Make sure that your libraries are available by adding the necessary commands. # .scrutinizer.yml before_commands: - sudo pip install abc # Python2 - sudo pip3 install abc # Python3 Tip: We are currently not using virtualenv to run pylint, when installing your modules make sure to use the command for the correct version. 2. Missing __init__.py files This error could also result from missing `__init__.py` files in your module folders. Make sure that you place one file in each sub-folder. Loading history...
9			from plumbum.cmd import git
			0 ignored issues – show Configuration introduced 2017-10-21 21:51 UTC by Report Bug Copy Issue Report The import `plumbum.cmd` could not be resolved. This can be caused by one of the following: 1. Missing Dependencies This error could indicate a configuration issue of Pylint. Make sure that your libraries are available by adding the necessary commands. # .scrutinizer.yml before_commands: - sudo pip install abc # Python2 - sudo pip3 install abc # Python3 Tip: We are currently not using virtualenv to run pylint, when installing your modules make sure to use the command for the correct version. 2. Missing __init__.py files This error could also result from missing `__init__.py` files in your module folders. Make sure that you place one file in each sub-folder. Loading history...
10
11			import changes
12
13			pytest_plugins = 'pytester'
			0 ignored issues – show Coding Style Naming introduced 2017-10-14 17:35 UTC by Report Bug Copy Issue Report The name `pytest_plugins` does not conform to the constant naming conventions (`(([A-Z_][A-Z0-9_])\|(__.__))$`). This check looks for invalid names for a range of different identifiers. You can set regular expressions to which the identifiers must conform if the defaults do not match your requirements. If your project includes a Pylint configuration file, the settings contained in that file take precedence. To find out more about Pylint, please refer to their site. Loading history...
14
15			# TODO: textwrap.dedent.heredoc
16			INIT_CONTENT = [
17			'"""A test app"""',
18			'',
19			"__version__ = '0.0.1'",
20			"__url__ = 'https://github.com/someuser/test_app'",
21			"__author__ = 'Some User'",
22			"__email__ = '[email protected]'"
23			]
24			SETUP_PY = [
25			'from setuptools import setup',
26			"setup(name='test_app'",
27			]
28			README_MARKDOWN = [
29			'# Test App',
30			'',
31			'This is the test application.'
32			]
33
34			PYTHON_MODULE = 'test_app'
35
36			PYTHON_PROJECT_CONTENT = {
37			'%s/__init__.py' % PYTHON_MODULE: INIT_CONTENT,
38			'setup.py': SETUP_PY,
39			'requirements.txt': ['pytest'],
40			}
41
42			FILE_CONTENT = {
43			'version.txt': ['0.0.1'],
44			'README.md': README_MARKDOWN,
45			'CHANGELOG.md': [''],
46			}
47
48			AUTH_TOKEN_ENVVAR = 'GITHUB_AUTH_TOKEN'
49
50			BUG_LABEL_JSON = [
51			{
52			'id': 52048163,
53			'url': 'https://api.github.com/repos/michaeljoseph/changes/labels/bug',
54			'name': 'bug',
55			'color': 'fc2929',
56			'default': True
57			}
58			]
59
60			ISSUE_URL = 'https://api.github.com/repos/michaeljoseph/test_app/issues/111'
61			PULL_REQUEST_JSON = {
62			'number': 111,
63			'title': 'The title of the pull request',
64			'body': 'An optional, longer description.',
65			'user': {
66			'login': 'michaeljoseph'
67			},
68			'labels': [
69			{'id': 1, 'name': 'bug'}
70			],
71			}
72
73			LABEL_URL = 'https://api.github.com/repos/michaeljoseph/test_app/labels'
74			BUG_LABEL_JSON = [
75			{
76			'id': 52048163,
77			'url': 'https://api.github.com/repos/michaeljoseph/test_app/labels/bug',
			0 ignored issues – show Coding Style introduced 2017-10-21 21:51 UTC by Report Bug Copy Issue Report This line is too long as per the coding-style (80/79). This check looks for lines that are too long. You can specify the maximum line length. Loading history...
78			'name': 'bug',
79			'color': 'fc2929',
80			'default': True
81			}
82			]
83
84			RELEASES_URL = 'https://api.github.com/repos/michaeljoseph/test_app/releases'
85
86
87			@pytest.fixture
88			def git_repo(tmpdir):
89			with CliRunner().isolated_filesystem() as repo_dir:
90			for file_path, content in FILE_CONTENT.items():
91			open(file_path, 'w').write(
92			'\n'.join(content)
93			)
94
95			git('init')
96			git(shlex.split('config --local user.email "[email protected]"'))
97			git(shlex.split('remote add origin https://github.com/michaeljoseph/test_app.git'))
			0 ignored issues – show Coding Style introduced 2017-10-30 10:28 UTC by Report Bug Copy Issue Report This line is too long as per the coding-style (91/79). This check looks for lines that are too long. You can specify the maximum line length. Loading history...
98
99			tmp_push_repo = Path(str(tmpdir))
100			git('init', '--bare', str(tmp_push_repo))
101			git(shlex.split('remote set-url --push origin {}'.format(tmp_push_repo.as_uri())))
			0 ignored issues – show Coding Style introduced 2017-10-30 11:33 UTC by Report Bug Copy Issue Report This line is too long as per the coding-style (90/79). This check looks for lines that are too long. You can specify the maximum line length. Loading history...
102
103			git('add', [file for file in FILE_CONTENT.keys()])
104
105			git('commit', '-m', 'Initial commit')
106			git(shlex.split('tag 0.0.1'))
107
108			yield repo_dir
109
110
111			@pytest.fixture
112			def python_module(git_repo):
			0 ignored issues – show Comprehensibility Bug introduced 2017-10-27 22:11 UTC by Report Bug Copy Issue Report `git_repo` is re-defining a name which is already available in the outer-scope (previously defined on line `88`). It is generally a bad practice to shadow variables from the outer-scope. In most cases, this is done unintentionally and might lead to unexpected behavior: param = 5 class Foo: def __init__(self, param): # "param" would be flagged here self.param = param Loading history...
113			os.mkdir(PYTHON_MODULE)
114
115			for file_path, content in PYTHON_PROJECT_CONTENT.items():
116			open(file_path, 'w').write(
117			'\n'.join(content)
118			)
119
120			git('add', [file for file in PYTHON_PROJECT_CONTENT.keys()])
121			git('commit', '-m', 'Python project initialisation')
122
123			yield
124
125
126			def github_merge_commit(pull_request_number):
127			from haikunator import Haikunator
			0 ignored issues – show Configuration introduced 2017-10-16 09:56 UTC by Report Bug Copy Issue Report The import `haikunator` could not be resolved. This can be caused by one of the following: 1. Missing Dependencies This error could indicate a configuration issue of Pylint. Make sure that your libraries are available by adding the necessary commands. # .scrutinizer.yml before_commands: - sudo pip install abc # Python2 - sudo pip3 install abc # Python3 Tip: We are currently not using virtualenv to run pylint, when installing your modules make sure to use the command for the correct version. 2. Missing __init__.py files This error could also result from missing `__init__.py` files in your module folders. Make sure that you place one file in each sub-folder. Loading history...
128
129			branch_name = Haikunator().haikunate()
130			commands = [
131			'checkout -b {}'.format(branch_name),
132			'commit --allow-empty -m "Test branch commit message"',
133			'checkout master',
134			'merge --no-ff {}'.format(branch_name),
135
136			'commit --allow-empty --amend -m '
137			'"Merge pull request #{} from test_app/{}"'.format(
138			pull_request_number,
139			branch_name,
140			)
141			]
142			for command in commands:
143			git(shlex.split(command))
144
145
146			# prompts_for_tool_configuration
147			@pytest.fixture
148			def with_releases_directory_and_bumpversion_file_prompt(mocker):
			0 ignored issues – show Coding Style Naming introduced 2017-10-18 06:53 UTC by Report Bug Copy Issue Report The name `with_releases_directory_...bumpversion_file_prompt` does not conform to the function naming conventions (`[a-z_][a-z0-9_]{2,30}$`). This check looks for invalid names for a range of different identifiers. You can set regular expressions to which the identifiers must conform if the defaults do not match your requirements. If your project includes a Pylint configuration file, the settings contained in that file take precedence. To find out more about Pylint, please refer to their site. Loading history...
149			prompt = mocker.patch(
150			'changes.config.click.prompt',
151			autospec=True
152			)
153			prompt.side_effect = [
154			# release_directory
155			'docs/releases',
156			# bumpversion files
157			'version.txt',
158			# quit prompt
159			'.',
160			# label descriptions
161			# 'Features',
162			# 'Bug Fixes'
163			]
164
165			prompt = mocker.patch(
166			'changes.config.prompt.choose_labels',
167			autospec=True
168			)
169			prompt.return_value = ['bug']
170
171
172			@pytest.fixture
173			def with_auth_token_prompt(mocker):
174			_ = mocker.patch('changes.config.click.launch')
175
176			prompt = mocker.patch('changes.config.click.prompt')
177			prompt.return_value = 'foo'
178
179			saved_token = None
180			if os.environ.get(AUTH_TOKEN_ENVVAR):
181			saved_token = os.environ[AUTH_TOKEN_ENVVAR]
182			del os.environ[AUTH_TOKEN_ENVVAR]
183
184			yield
185
186			if saved_token:
187			os.environ[AUTH_TOKEN_ENVVAR] = saved_token
188
189
190			@pytest.fixture
191			def with_auth_token_envvar():
192			saved_token = None
193			if os.environ.get(AUTH_TOKEN_ENVVAR):
194			saved_token = os.environ[AUTH_TOKEN_ENVVAR]
195
196			os.environ[AUTH_TOKEN_ENVVAR] = 'foo'
197
198			yield
199
200			if saved_token:
201			os.environ[AUTH_TOKEN_ENVVAR] = saved_token
202			else:
203			del os.environ[AUTH_TOKEN_ENVVAR]
204
205
206			@pytest.fixture
207			def changes_config_in_tmpdir(monkeypatch, tmpdir):
208			IS_WINDOWS = 'win32' in str(sys.platform).lower()
			0 ignored issues – show Coding Style Naming introduced 2017-10-19 22:04 UTC by Report Bug Copy Issue Report The name `IS_WINDOWS` does not conform to the variable naming conventions (`[a-z_][a-z0-9_]{2,30}$`). This check looks for invalid names for a range of different identifiers. You can set regular expressions to which the identifiers must conform if the defaults do not match your requirements. If your project includes a Pylint configuration file, the settings contained in that file take precedence. To find out more about Pylint, please refer to their site. Loading history...
209
210			changes_config_file = Path(str(tmpdir.join('.changes')))
211			monkeypatch.setattr(
212			changes.config,
213			'expandvars' if IS_WINDOWS else 'expanduser',
214			lambda x: str(changes_config_file)
215			)
216			assert not changes_config_file.exists()
217			return changes_config_file
218
219
220			@pytest.fixture
221			def configured(git_repo, changes_config_in_tmpdir):
			0 ignored issues – show Comprehensibility Bug introduced 2017-10-27 13:56 UTC by Report Bug Copy Issue Report `changes_config_in_tmpdir` is re-defining a name which is already available in the outer-scope (previously defined on line `207`). It is generally a bad practice to shadow variables from the outer-scope. In most cases, this is done unintentionally and might lead to unexpected behavior: param = 5 class Foo: def __init__(self, param): # "param" would be flagged here self.param = param Loading history... Comprehensibility Bug introduced 2017-10-27 13:56 UTC by Report Bug Copy Issue Report `git_repo` is re-defining a name which is already available in the outer-scope (previously defined on line `88`). It is generally a bad practice to shadow variables from the outer-scope. In most cases, this is done unintentionally and might lead to unexpected behavior: param = 5 class Foo: def __init__(self, param): # "param" would be flagged here self.param = param Loading history...
222			changes_config_in_tmpdir.write_text(textwrap.dedent(
223			"""\
224			[changes]
225			auth_token = "foo"
226			"""
227			))
228
229			Path('.changes.toml').write_text(textwrap.dedent(
			0 ignored issues – show Bug introduced 2017-10-24 21:49 UTC by Report Bug Copy Issue Report The Instance of `Path` does not seem to have a member named `write_text`. This check looks for calls to members that are non-existent. These calls will fail. The member could have been renamed or removed. Loading history...
230			"""\
231			[changes]
232			releases_directory = "docs/releases"
233
234			[changes.labels.bug]
235			default = true
236			id = 208045946
237			url = "https://api.github.com/repos/michaeljoseph/test_app/labels/bug"
238			name = "bug"
239			description = "Bug"
240			color = "f29513"
241			"""
242			))
243
244			Path('.bumpversion.cfg').write_text(textwrap.dedent(
			0 ignored issues – show Bug introduced 2017-10-24 21:49 UTC by Report Bug Copy Issue Report The Instance of `Path` does not seem to have a member named `write_text`. This check looks for calls to members that are non-existent. These calls will fail. The member could have been renamed or removed. Loading history...
245			"""\
246			[bumpversion]
247			current_version = 0.0.1
248
249			[bumpversion:file:version.txt]
250			"""
251			))
252
253			for file_to_add in ['.changes.toml', '.bumpversion.cfg']:
254			git('add', file_to_add)
255			git('commit', '-m', 'Add changes configuration files')
256
257			return str(changes_config_in_tmpdir)
258

michaeljoseph / changes

Pull Request — master (#127)

git_repo() B

Complexity

Size

Duplication

Importance

1. Missing Dependencies

2. Missing __init__.py files

1. Missing Dependencies

2. Missing __init__.py files

1. Missing Dependencies

2. Missing __init__.py files

Duplication Side-by-Side

Filter issues like

2. Missing init.py files

2. Missing init.py files

2. Missing init.py files