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-12 12:03 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'}
    ],
    'url': 'https://api.github.com/repos/michaeljoseph/test_app/issues/111'
}

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			'url': 'https://api.github.com/repos/michaeljoseph/test_app/issues/111'
72			}
73
74			LABEL_URL = 'https://api.github.com/repos/michaeljoseph/test_app/labels'
75			BUG_LABEL_JSON = [
76			{
77			'id': 52048163,
78			'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...
79			'name': 'bug',
80			'color': 'fc2929',
81			'default': True
82			}
83			]
84
85			RELEASES_URL = 'https://api.github.com/repos/michaeljoseph/test_app/releases'
86
87
88			@pytest.fixture
89			def git_repo(tmpdir):
90			with CliRunner().isolated_filesystem() as repo_dir:
91			for file_path, content in FILE_CONTENT.items():
92			open(file_path, 'w').write(
93			'\n'.join(content)
94			)
95
96			git('init')
97			git(shlex.split('config --local user.email "[email protected]"'))
98			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...
99
100			tmp_push_repo = Path(str(tmpdir))
101			git('init', '--bare', str(tmp_push_repo))
102			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...
103
104			git('add', [file for file in FILE_CONTENT.keys()])
105
106			git('commit', '-m', 'Initial commit')
107			git(shlex.split('tag 0.0.1'))
108
109			yield repo_dir
110
111
112			@pytest.fixture
113			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 `89`). 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...
114			os.mkdir(PYTHON_MODULE)
115
116			for file_path, content in PYTHON_PROJECT_CONTENT.items():
117			open(file_path, 'w').write(
118			'\n'.join(content)
119			)
120
121			git('add', [file for file in PYTHON_PROJECT_CONTENT.keys()])
122			git('commit', '-m', 'Python project initialisation')
123
124			yield
125
126
127			def github_merge_commit(pull_request_number):
128			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...
129
130			branch_name = Haikunator().haikunate()
131			commands = [
132			'checkout -b {}'.format(branch_name),
133			'commit --allow-empty -m "Test branch commit message"',
134			'checkout master',
135			'merge --no-ff {}'.format(branch_name),
136
137			'commit --allow-empty --amend -m '
138			'"Merge pull request #{} from test_app/{}"'.format(
139			pull_request_number,
140			branch_name,
141			)
142			]
143			for command in commands:
144			git(shlex.split(command))
145
146
147			# prompts_for_tool_configuration
148			@pytest.fixture
149			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...
150			prompt = mocker.patch(
151			'changes.config.click.prompt',
152			autospec=True
153			)
154			prompt.side_effect = [
155			# release_directory
156			'docs/releases',
157			# bumpversion files
158			'version.txt',
159			# quit prompt
160			'.',
161			# label descriptions
162			# 'Features',
163			# 'Bug Fixes'
164			]
165
166			prompt = mocker.patch(
167			'changes.config.prompt.choose_labels',
168			autospec=True
169			)
170			prompt.return_value = ['bug']
171
172
173			@pytest.fixture
174			def with_auth_token_prompt(mocker):
175			_ = mocker.patch('changes.config.click.launch')
176
177			prompt = mocker.patch('changes.config.click.prompt')
178			prompt.return_value = 'foo'
179
180			saved_token = None
181			if os.environ.get(AUTH_TOKEN_ENVVAR):
182			saved_token = os.environ[AUTH_TOKEN_ENVVAR]
183			del os.environ[AUTH_TOKEN_ENVVAR]
184
185			yield
186
187			if saved_token:
188			os.environ[AUTH_TOKEN_ENVVAR] = saved_token
189
190
191			@pytest.fixture
192			def with_auth_token_envvar():
193			saved_token = None
194			if os.environ.get(AUTH_TOKEN_ENVVAR):
195			saved_token = os.environ[AUTH_TOKEN_ENVVAR]
196
197			os.environ[AUTH_TOKEN_ENVVAR] = 'foo'
198
199			yield
200
201			if saved_token:
202			os.environ[AUTH_TOKEN_ENVVAR] = saved_token
203			else:
204			del os.environ[AUTH_TOKEN_ENVVAR]
205
206
207			@pytest.fixture
208			def changes_config_in_tmpdir(monkeypatch, tmpdir):
209			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...
210
211			changes_config_file = Path(str(tmpdir.join('.changes')))
212			monkeypatch.setattr(
213			changes.config,
214			'expandvars' if IS_WINDOWS else 'expanduser',
215			lambda x: str(changes_config_file)
216			)
217			assert not changes_config_file.exists()
218			return changes_config_file
219
220
221			@pytest.fixture
222			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 `208`). 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 `89`). 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...
223			changes_config_in_tmpdir.write_text(textwrap.dedent(
224			"""\
225			[changes]
226			auth_token = "foo"
227			"""
228			))
229
230			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...
231			"""\
232			[changes]
233			releases_directory = "docs/releases"
234
235			[changes.labels.bug]
236			default = true
237			id = 208045946
238			url = "https://api.github.com/repos/michaeljoseph/test_app/labels/bug"
239			name = "bug"
240			description = "Bug"
241			color = "f29513"
242			"""
243			))
244
245			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...
246			"""\
247			[bumpversion]
248			current_version = 0.0.1
249
250			[bumpversion:file:version.txt]
251			"""
252			))
253
254			for file_to_add in ['.changes.toml', '.bumpversion.cfg']:
255			git('add', file_to_add)
256			git('commit', '-m', 'Add changes configuration files')
257
258			return str(changes_config_in_tmpdir)
259

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