config() - Code Metrics - Inspection of "PR fixing Windows CI/Travis" - jacebrowning/gitman - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — develop (#140)

unknown

created 2017-01-08 00:37 UTC

config() B

↳ Parent: Project

Complexity

Conditions

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes	7
Bugs	4	Features	0

Metric	Value
cc	5
c	7
b	4
f	0
dl	0
loc	23
rs	8.2508

# pylint: disable=redefined-outer-name,unused-argument,unused-variable,singleton-comparison,expression-not-assigned
class SomeClass:
    def some_method(self):
        """Do x and return foo."""

import os
import shutil
from contextlib import suppress
import logging
import tempfile

import pytest
from expecter import expect
# .scrutinizer.yml
before_commands:
    - sudo pip install abc # Python2
    - sudo pip3 install abc # Python3
from freezegun import freeze_time
# .scrutinizer.yml
before_commands:
    - sudo pip install abc # Python2
    - sudo pip3 install abc # Python3

import gitman
from gitman.models import Config
from gitman.exceptions import UncommittedChanges, InvalidRepository

from .utilities import strip


CONFIG = """
location: deps
sources:
- name: gitman_1
  link: ''
  repo: https://github.com/jacebrowning/gitman-demo
  rev: example-branch
- name: gitman_2
  link: ''
  repo: https://github.com/jacebrowning/gitman-demo
  rev: example-tag
- name: gitman_3
  link: ''
  repo: https://github.com/jacebrowning/gitman-demo
  rev: 9bf18e16b956041f0267c21baad555a23237b52e
""".lstrip()

log = logging.getLogger(__name__)



@pytest.fixture
def config(root=os.path.normpath(tempfile.gettempdir() + "/gitman-shared")):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
    with suppress(FileNotFoundError, PermissionError):
        shutil.rmtree(root)
    with suppress(FileExistsError):
        os.makedirs(root)
    os.chdir(root)
    log.info("Temporary directory: %s", root)

    if os.name == 'nt':
        if not os.path.exists(".git"):
            os.system('type nul >>.git')
        else:
            os.system('copy /b ".git" +,, 1>nul')
    else:
        os.system("touch .git")

    config = Config(root=root)
    config.__mapper__.text = CONFIG  # pylint: disable=no-member


    log.debug("File listing: %s", os.listdir(root))

    return config


def describe_install():
class SomeClass:
    def some_method(self):
        """Do x and return foo."""

    def it_creates_missing_directories(config):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        expect(os.path.isdir(config.location)) == False

        expect(gitman.install('gitman_1', depth=1)) == True

        expect(os.listdir(config.location)) == ['gitman_1']

    def it_should_not_modify_config(config):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        expect(gitman.install('gitman_1', depth=1)) == True

        expect(config.__mapper__.text) == CONFIG

    def it_merges_sources(config):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        config.__mapper__.text = strip("""
        location: deps
        sources:
        - name: gitman_1
          link: ''
          repo: https://github.com/jacebrowning/gitman-demo
          rev: example-branch
        sources_locked:
        - name: gitman_2
          link: ''
          repo: https://github.com/jacebrowning/gitman-demo
          rev: example-branch
        - name: gitman_3
          link: ''
          repo: https://github.com/jacebrowning/gitman-demo
          rev: 7bd138fe7359561a8c2ff9d195dff238794ccc04
        """)

        expect(gitman.install(depth=1)) == True

        expect(len(os.listdir(config.location))) == 3

    def it_can_handle_missing_locked_sources(config):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        config.__mapper__.text = strip("""
        location: deps
        sources:
        - name: gitman_1
          link: ''
          repo: https://github.com/jacebrowning/gitman-demo
          rev: example-branch
        sources_locked:
        - name: gitman_2
          link: ''
          repo: https://github.com/jacebrowning/gitman-demo
          rev: 7bd138fe7359561a8c2ff9d195dff238794ccc04
        """)

        expect(gitman.install('gitman_1', depth=1)) == True

        expect(os.listdir(config.location)) == ['gitman_1']

    def describe_links():
class SomeClass:
    def some_method(self):
        """Do x and return foo."""

        @pytest.fixture
        def config_with_link(config):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
            config.__mapper__.text = strip("""
            location: deps
            sources:
            - name: gitman_1
              link: my_link
              repo: https://github.com/jacebrowning/gitman-demo
              rev: 7bd138fe7359561a8c2ff9d195dff238794ccc04
            """)

            return config

        @pytest.mark.skipif(os.name == 'nt', reason="no symlink on Windows")
        def it_should_create_links(config_with_link):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
            expect(gitman.install(depth=1)) == True

            expect(os.listdir()).contains('my_link')

        @pytest.mark.skipif(os.name == 'nt', reason="no symlink on Windows")
        def it_should_not_overwrite_files(config_with_link):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
            os.system("touch my_link")

            with pytest.raises(RuntimeError):
                gitman.install(depth=1)

        @pytest.mark.skipif(os.name == 'nt', reason="no symlink on Windows")
        def it_overwrites_files_with_force(config_with_link):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
            os.system("touch my_link")

            expect(gitman.install(depth=1, force=True)) == True


def describe_uninstall():
class SomeClass:
    def some_method(self):
        """Do x and return foo."""

    def it_deletes_dependencies_when_they_exist(config):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        gitman.install('gitman_1', depth=1)
        expect(os.path.isdir(config.location)) == True

        expect(gitman.uninstall()) == True

        expect(os.path.exists(config.location)) == False

    def it_should_not_fail_when_no_dependnecies_exist(config):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        expect(os.path.isdir(config.location)) == False

        expect(gitman.uninstall()) == True

    def it_deletes_the_log_file(config):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        gitman.install('gitman_1', depth=1)
        gitman.list()
        expect(os.path.exists(config.log_path)) == True

        gitman.uninstall()
        expect(os.path.exists(config.log_path)) == False


def describe_update():
class SomeClass:
    def some_method(self):
        """Do x and return foo."""

    def it_should_not_modify_config(config):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        gitman.update('gitman_1', depth=1)

        expect(config.__mapper__.text) == CONFIG

    def it_locks_previously_locked_dependnecies(config):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        config.__mapper__.text = strip("""
        location: deps
        sources:
        - name: gitman_1
          link: ''
          repo: https://github.com/jacebrowning/gitman-demo
          rev: example-branch
        - name: gitman_2
          link: ''
          repo: https://github.com/jacebrowning/gitman-demo
          rev: example-tag
        sources_locked:
        - name: gitman_2
          link: ''
          repo: https://github.com/jacebrowning/gitman-demo
          rev: (old revision)
        """)

        gitman.update(depth=1)

        expect(config.__mapper__.text) == strip("""
        location: deps
        sources:
        - name: gitman_1
          link: ''
          repo: https://github.com/jacebrowning/gitman-demo
          rev: example-branch
        - name: gitman_2
          link: ''
          repo: https://github.com/jacebrowning/gitman-demo
          rev: example-tag
        sources_locked:
        - name: gitman_2
          link: ''
          repo: https://github.com/jacebrowning/gitman-demo
          rev: 7bd138fe7359561a8c2ff9d195dff238794ccc04
        """)

    def it_should_not_lock_dependnecies_when_disabled(config):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        config.__mapper__.text = strip("""
        location: deps
        sources:
        - name: gitman_1
          link: ''
          repo: https://github.com/jacebrowning/gitman-demo
          rev: example-branch
        - name: gitman_2
          link: ''
          repo: https://github.com/jacebrowning/gitman-demo
          rev: example-tag
        sources_locked:
        - name: gitman_2
          link: ''
          repo: https://github.com/jacebrowning/gitman-demo
          rev: (old revision)
        """)

        gitman.update(depth=1, lock=False)

        expect(config.__mapper__.text) == strip("""
        location: deps
        sources:
        - name: gitman_1
          link: ''
          repo: https://github.com/jacebrowning/gitman-demo
          rev: example-branch
        - name: gitman_2
          link: ''
          repo: https://github.com/jacebrowning/gitman-demo
          rev: example-tag
        sources_locked:
        - name: gitman_2
          link: ''
          repo: https://github.com/jacebrowning/gitman-demo
          rev: (old revision)
        """)

    def it_should_lock_all_dependencies_when_enabled(config):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        gitman.update(depth=1, lock=True)

        expect(config.__mapper__.text) == CONFIG + strip("""
        sources_locked:
        - name: gitman_1
          link: ''
          repo: https://github.com/jacebrowning/gitman-demo
          rev: 1de84ca1d315f81b035cd7b0ecf87ca2025cdacd
        - name: gitman_2
          link: ''
          repo: https://github.com/jacebrowning/gitman-demo
          rev: 7bd138fe7359561a8c2ff9d195dff238794ccc04
        - name: gitman_3
          link: ''
          repo: https://github.com/jacebrowning/gitman-demo
          rev: 9bf18e16b956041f0267c21baad555a23237b52e
        """)


def describe_list():
class SomeClass:
    def some_method(self):
        """Do x and return foo."""

    @freeze_time("2012-01-14 12:00:01")
    def it_updates_the_log(config):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        gitman.install()
        gitman.list()
        with open(config.log_path) as stream:
            contents = stream.read().replace("/private", "")

        temp_path = os.path.normpath(tempfile.gettempdir())
        test_string = (
            "2012-01-14 12:00:01\n" +
            temp_path + os.path.normpath("/gitman-shared/deps/gitman_1") + ": https://github.com/jacebrowning/gitman-demo @ 1de84ca1d315f81b035cd7b0ecf87ca2025cdacd\n" +

            temp_path + os.path.normpath("/gitman-shared/deps/gitman_1/gitman_sources/gdm_3") + ": https://github.com/jacebrowning/gdm-demo @ 050290bca3f14e13fd616604202b579853e7bfb0\n" +

            temp_path + os.path.normpath("/gitman-shared/deps/gitman_1/gitman_sources/gdm_3/gitman_sources/gdm_3") + ": https://github.com/jacebrowning/gdm-demo @ fb693447579235391a45ca170959b5583c5042d8\n" +

            temp_path + os.path.normpath("/gitman-shared/deps/gitman_1/gitman_sources/gdm_3/gitman_sources/gdm_4") + ": https://github.com/jacebrowning/gdm-demo @ 63ddfd82d308ddae72d31b61cb8942c898fa05b5\n" +

            temp_path + os.path.normpath("/gitman-shared/deps/gitman_1/gitman_sources/gdm_4") + ": https://github.com/jacebrowning/gdm-demo @ 63ddfd82d308ddae72d31b61cb8942c898fa05b5\n" +

            temp_path + os.path.normpath("/gitman-shared/deps/gitman_2") + ": https://github.com/jacebrowning/gitman-demo @ 7bd138fe7359561a8c2ff9d195dff238794ccc04\n" +

            temp_path + os.path.normpath("/gitman-shared/deps/gitman_3") + ": https://github.com/jacebrowning/gitman-demo @ 9bf18e16b956041f0267c21baad555a23237b52e\n"

        )
        expect(contents) == strip(test_string, end='\n\n')


def describe_lock():
class SomeClass:
    def some_method(self):
        """Do x and return foo."""

    def it_records_all_versions_when_no_arguments(config):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        expect(gitman.update(depth=1, lock=False)) == True
        expect(gitman.lock()) == True

        expect(config.__mapper__.text) == CONFIG + strip("""
        sources_locked:
        - name: gitman_1
          link: ''
          repo: https://github.com/jacebrowning/gitman-demo
          rev: 1de84ca1d315f81b035cd7b0ecf87ca2025cdacd
        - name: gitman_2
          link: ''
          repo: https://github.com/jacebrowning/gitman-demo
          rev: 7bd138fe7359561a8c2ff9d195dff238794ccc04
        - name: gitman_3
          link: ''
          repo: https://github.com/jacebrowning/gitman-demo
          rev: 9bf18e16b956041f0267c21baad555a23237b52e
        """) == config.__mapper__.text

    def it_records_specified_dependencies(config):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        expect(gitman.update(depth=1, lock=False)) == True
        expect(gitman.lock('gitman_1', 'gitman_3')) == True

        expect(config.__mapper__.text) == CONFIG + strip("""
        sources_locked:
        - name: gitman_1
          link: ''
          repo: https://github.com/jacebrowning/gitman-demo
          rev: 1de84ca1d315f81b035cd7b0ecf87ca2025cdacd
        - name: gitman_3
          link: ''
          repo: https://github.com/jacebrowning/gitman-demo
          rev: 9bf18e16b956041f0267c21baad555a23237b52e
        """) == config.__mapper__.text

    def it_should_fail_on_dirty_repositories(config):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        expect(gitman.update(depth=1, lock=False)) == True
        os.remove("deps/gitman_1/.project")

        with pytest.raises(UncommittedChanges):
            gitman.lock()

    def it_should_fail_on_invalid_repositories(config):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        os.system("mkdir deps && touch deps/gitman_1")

        with pytest.raises(InvalidRepository):
            gitman.lock()

        expect(config.__mapper__.text).does_not_contain("<unknown>")


Pull Request — develop (#140)

config() B

Complexity

Size

Duplication

Importance

1. Missing Dependencies

2. Missing init.py files

1. Missing Dependencies

2. Missing init.py files

1			# pylint: disable=redefined-outer-name,unused-argument,unused-variable,singleton-comparison,expression-not-assigned
			0 ignored issues – show introduced 2016-03-31 00:34 UTC by Report Bug Copy Issue Report Bad option value 'singleton-comparison' Loading history... introduced 2016-04-22 01:39 UTC by Report Bug Copy Issue Report Locally disabling redefined-outer-name (W0621) Loading history... introduced 2016-04-22 01:39 UTC by Report Bug Copy Issue Report Locally disabling unused-argument (W0613) Loading history... introduced 2016-04-22 01:39 UTC by Report Bug Copy Issue Report Locally disabling unused-variable (W0612) Loading history... introduced 2016-04-22 01:39 UTC by Report Bug Copy Issue Report Locally disabling expression-not-assigned (W0106) Loading history... Coding Style introduced 2016-03-14 20:50 UTC by Report Bug Copy Issue Report This module should have a docstring. The coding style of this project requires that you add a docstring to this code element. Below, you find an example for methods: class SomeClass: def some_method(self): """Do x and return foo.""" If you would like to know more about docstrings, we recommend to read PEP-257: Docstring Conventions. Loading history...
2
3			import os
4			import shutil
5			from contextlib import suppress
6			import logging
7			import tempfile
8
9			import pytest
10			from expecter import expect
			0 ignored issues – show Configuration introduced 2016-03-31 00:34 UTC by Report Bug Copy Issue Report The import `expecter` 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...
11			from freezegun import freeze_time
			0 ignored issues – show Configuration introduced 2016-04-03 03:45 UTC by Report Bug Copy Issue Report The import `freezegun` 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...
12
13			import gitman
14			from gitman.models import Config
15			from gitman.exceptions import UncommittedChanges, InvalidRepository
16
17			from .utilities import strip
18
19
20			CONFIG = """
21			location: deps
22			sources:
23			- name: gitman_1
24			link: ''
25			repo: https://github.com/jacebrowning/gitman-demo
26			rev: example-branch
27			- name: gitman_2
28			link: ''
29			repo: https://github.com/jacebrowning/gitman-demo
30			rev: example-tag
31			- name: gitman_3
32			link: ''
33			repo: https://github.com/jacebrowning/gitman-demo
34			rev: 9bf18e16b956041f0267c21baad555a23237b52e
35			""".lstrip()
36
37			log = logging.getLogger(__name__)

jacebrowning / gitman

Pull Request — develop (#140)

config() B

Complexity

Size

Duplication

Importance

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