test_publish() - Code Metrics - Inspection of "publish: commit, tag and publish release" - michaeljoseph/changes - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#126)

by Michael

created 2017-10-31 15:29 UTC

test_publish() B

↳ Parent: Project

Complexity

Conditions

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
cc	6
c	2
b	0
f	0
dl	0
loc	90
rs	7.2258

How to fix Long Method

from datetime import date
import shlex
import textwrap
from pathlib import Path

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

from changes.commands import init, stage, publish
from .conftest import github_merge_commit, ISSUE_URL, LABEL_URL, PULL_REQUEST_JSON, BUG_LABEL_JSON, RELEASES_URL



@pytest.fixture
def answer_prompts(mocker):
    prompt = mocker.patch(
        'changes.commands.publish.click.confirm',
        autospec=True,
    )
    prompt.side_effect = [
        'y'
    ]


def test_publish_no_staged_release(
    capsys,
    configured
):
    init.init()
    publish.publish()

    expected_output = textwrap.dedent(
        """\
        No staged release to publish...
        """
    )
    out, _ = capsys.readouterr()
    assert expected_output == out


@responses.activate
def test_publish(
    capsys,
    configured,
    answer_prompts,
param = 5

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

    github_merge_commit(111)
    responses.add(
        responses.GET,
        ISSUE_URL.format('111'),
        json=PULL_REQUEST_JSON,
        status=200,
        content_type='application/json'
    )
    responses.add(
        responses.GET,
        LABEL_URL,
        json=BUG_LABEL_JSON,
        status=200,
        content_type='application/json'
    )
    responses.add(
        responses.POST,
        RELEASES_URL,
        json={'upload_url': 'foo'},
        status=200,
        content_type='application/json'
    )

    init.init()
    stage.stage(
        draft=False,
        release_name='Icarus',
        release_description='The first flight'
    )
    publish.publish()

    release_notes_path = Path('docs').joinpath('releases').joinpath('0.0.2.md')

    pre = textwrap.dedent(
        """\
        Staging [fix] release for version 0.0.2...
        Running: bumpversion --verbose --allow-dirty --no-commit --no-tag patch...

        Generating Release...
        Writing release notes to {release_notes_path}...
        Publishing release 0.0.2...
        Running: git add version.txt .bumpversion.cfg {release_notes_path}...
        Running: git commit --message="# 0.0.2 ({release_date}) Icarus
        """.format(
            release_notes_path=release_notes_path,
            release_date=date.today().isoformat(),
        )
    ).splitlines()

    expected_release_notes_content = [
        'The first flight',
        '## Bug',
        '    ',
        '* #111 The title of the pull request',
        '    ',
    ]

    post = textwrap.dedent(
        """\
        "...
        Running: git tag 0.0.2...
        Running: git push --tags...
        Creating GitHub Release...
        Published release 0.0.2...
        """
    ).splitlines()

    out, _ = capsys.readouterr()

    assert pre + expected_release_notes_content + post == out.splitlines()

    last_commit = git(shlex.split('show --name-only'))
    expected_files = [
        'version.txt',
        '.bumpversion.cfg',
        release_notes_path,
    ]
    assert [
        expected_file
        for expected_file in expected_files
        if str(expected_file) in last_commit
    ]

    assert '0.0.2' in git(shlex.split('tag --list'))


Pull Request — master (#126)

test_publish() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

1. Missing Dependencies

2. Missing init.py files

1. Missing Dependencies

2. Missing init.py files

1			from datetime import date
2			import shlex
3			import textwrap
4			from pathlib import Path
5
6			from plumbum.cmd import git
			0 ignored issues – show Configuration introduced 2015-11-21 13:43 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...
7			import pytest
8			import responses
			0 ignored issues – show Configuration introduced 2017-10-28 23:12 UTC by Report Bug Copy Issue Report The import `responses` 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
10			from changes.commands import init, stage, publish
11			from .conftest import github_merge_commit, ISSUE_URL, LABEL_URL, PULL_REQUEST_JSON, BUG_LABEL_JSON, RELEASES_URL
			0 ignored issues – show Coding Style introduced 2017-10-28 23:12 UTC by Report Bug Copy Issue Report This line is too long as per the coding-style (112/79). This check looks for lines that are too long. You can specify the maximum line length. Loading history...
12
13
14			@pytest.fixture
15			def answer_prompts(mocker):
16			prompt = mocker.patch(
17			'changes.commands.publish.click.confirm',
18			autospec=True,
19			)
20			prompt.side_effect = [
21			'y'
22			]
23
24
25			def test_publish_no_staged_release(
26			capsys,
27			configured
28			):
29			init.init()
30			publish.publish()
31
32			expected_output = textwrap.dedent(
33			"""\
34			No staged release to publish...
35			"""
36			)
37			out, _ = capsys.readouterr()
38			assert expected_output == out
39
40
41			@responses.activate
42			def test_publish(
43			capsys,
44			configured,
45			answer_prompts,
			0 ignored issues – show Comprehensibility Bug introduced 2017-10-28 23:12 UTC by Report Bug Copy Issue Report `answer_prompts` is re-defining a name which is already available in the outer-scope (previously defined on line `15`). 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...
46			):
47
48			github_merge_commit(111)
49			responses.add(
50			responses.GET,
51			ISSUE_URL.format('111'),
52			json=PULL_REQUEST_JSON,
53			status=200,
54			content_type='application/json'
55			)
56			responses.add(
57			responses.GET,
58			LABEL_URL,
59			json=BUG_LABEL_JSON,
60			status=200,
61			content_type='application/json'
62			)
63			responses.add(
64			responses.POST,
65			RELEASES_URL,
66			json={'upload_url': 'foo'},
67			status=200,
68			content_type='application/json'
69			)
70
71			init.init()
72			stage.stage(
73			draft=False,
74			release_name='Icarus',
75			release_description='The first flight'
76			)
77			publish.publish()
78
79			release_notes_path = Path('docs').joinpath('releases').joinpath('0.0.2.md')
80
81			pre = textwrap.dedent(
82			"""\
83			Staging [fix] release for version 0.0.2...
84			Running: bumpversion --verbose --allow-dirty --no-commit --no-tag patch...
			0 ignored issues – show Coding Style introduced 2017-10-28 22:22 UTC by Report Bug Copy Issue Report This line is too long as per the coding-style (82/79). This check looks for lines that are too long. You can specify the maximum line length. Loading history...
85			Generating Release...
86			Writing release notes to {release_notes_path}...
87			Publishing release 0.0.2...
88			Running: git add version.txt .bumpversion.cfg {release_notes_path}...
89			Running: git commit --message="# 0.0.2 ({release_date}) Icarus
90			""".format(
91			release_notes_path=release_notes_path,
92			release_date=date.today().isoformat(),
93			)
94			).splitlines()
95
96			expected_release_notes_content = [
97			'The first flight',
98			'## Bug',
99			' ',
100			'* #111 The title of the pull request',
101			' ',
102			]
103
104			post = textwrap.dedent(
105			"""\
106			"...
107			Running: git tag 0.0.2...
108			Running: git push --tags...
109			Creating GitHub Release...
110			Published release 0.0.2...
111			"""
112			).splitlines()
113
114			out, _ = capsys.readouterr()
115
116			assert pre + expected_release_notes_content + post == out.splitlines()
117
118			last_commit = git(shlex.split('show --name-only'))
119			expected_files = [
120			'version.txt',
121			'.bumpversion.cfg',
122			release_notes_path,
123			]
124			assert [
125			expected_file
126			for expected_file in expected_files
127			if str(expected_file) in last_commit
128			]
129
130			assert '0.0.2' in git(shlex.split('tag --list'))
131

michaeljoseph / changes

Pull Request — master (#126)

test_publish() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

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