test_publish() - 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

test_publish() F

↳ Parent: Project

Complexity

Conditions

Size

Total Lines

103

Duplication

Lines	0
Ratio	0 %

Importance

Changes	3
Bugs	0	Features	0

Metric	Value
cc	9
c	3
b	0
f	0
dl	0
loc	103
rs	3.1304

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

import changes
from changes.commands import 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
):
    changes.initialise()
    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,
        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'
    )

    changes.initialise()
    stage.stage(
        draft=False,
        release_name='Icarus',
        release_description='The first flight'
    )

    release_notes_path = Path('docs').joinpath('releases').joinpath('0.0.2-2017-11-06-Icarus.md')

    assert release_notes_path.exists()

    
    publish.publish()

    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'))

    assert release_notes_path.exists()

    expected_release_notes = [
        '# 0.0.2 ({}) Icarus'.format(date.today().isoformat()),
        'The first flight',
        '## Bug',
        '    ',
        '* #111 The title of the pull request',
        '    ',
    ]
    assert expected_release_notes == release_notes_path.read_text().splitlines()



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

Pull Request — master (#127)

test_publish() F

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

michaeljoseph / changes

Pull Request — master (#127)

test_publish() F

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