it_should_not_overwrite_files() - Code Metrics - Inspection of "Support post-install scripts" - jacebrowning/gitman - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — develop (#148)

by Jace

created 2017-01-20 22:39 UTC

it_should_not_overwrite_files() A

↳ Parent: describe_links()

Complexity

Conditions

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	2
c	1
b	0
f	0
dl	0
loc	6
rs	9.4285

# 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 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 import shell
from gitman.models import Config
from gitman.exceptions import UncommittedChanges, InvalidRepository

from .utilities import strip


ROOT = os.path.join(os.path.dirname(os.path.dirname(__file__)))
TMP = os.path.join(ROOT, 'tmp')

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

log = logging.getLogger(__name__)



@pytest.yield_fixture
def config():
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
    log.info("Temporary directory: %s", TMP)

    with suppress(FileNotFoundError, PermissionError):
        shutil.rmtree(TMP)
    with suppress(FileExistsError):
        os.makedirs(TMP)
    os.chdir(TMP)

    os.system("touch .git")
    config = Config(root=TMP)
    config.__mapper__.text = CONFIG


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

    yield config

    os.chdir(ROOT)


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

    def it_creates_a_new_config_file(tmpdir):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        tmpdir.chdir()

        expect(gitman.init()) == True

        expect(Config().__mapper__.text) == strip("""

        location: gitman_sources
        sources:
        - name: sample_dependency
          repo: https://github.com/githubtraining/hellogitworld
          rev: master
          link: ''
          scripts: []
        sources_locked:
        - name: sample_dependency
          repo: https://github.com/githubtraining/hellogitworld
          rev: ebbbf773431ba07510251bb03f9525c7bab2b13a
          link: ''
          scripts: []
        """)

    def it_does_not_modify_existing_config_file(config):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        expect(gitman.init()) == False

        expect(config.__mapper__.text) == 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."""
        shell.rm(config.location)

        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
          repo: https://github.com/jacebrowning/gitman-demo
          rev: example-branch
          link: ''
          scripts: []
        sources_locked:
        - name: gitman_2
          repo: https://github.com/jacebrowning/gitman-demo
          rev: example-branch
          link: ''
          scripts: []
        - name: gitman_3
          repo: https://github.com/jacebrowning/gitman-demo
          rev: 7bd138fe7359561a8c2ff9d195dff238794ccc04
          link: ''
          scripts: []
        """)

        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
          repo: https://github.com/jacebrowning/gitman-demo
          rev: example-branch
          link: ''
          scripts: []
        sources_locked:
        - name: gitman_2
          repo: https://github.com/jacebrowning/gitman-demo
          rev: 7bd138fe7359561a8c2ff9d195dff238794ccc04
          link: ''
          scripts: []
        """)

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

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

    def it_detects_invalid_repositories(config):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        shell.rm(os.path.join("deps", "gitman_1", ".git"))
        shell.mkdir(os.path.join("deps", "gitman_1", ".git"))

        try:
            with pytest.raises(InvalidRepository):
                expect(gitman.install('gitman_1', depth=1)) == False

        finally:
            shell.rm(os.path.join("deps", "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
              repo: https://github.com/jacebrowning/gitman-demo
              rev: 7bd138fe7359561a8c2ff9d195dff238794ccc04
              link: my_link
              scripts: []
            """)

            return config

        @pytest.mark.xfail(os.name == 'nt', reason="No symlinks 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.xfail(os.name == 'nt', reason="No symlinks 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.xfail(os.name == 'nt', reason="No symlinks 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_scripts():
class SomeClass:
    def some_method(self):
        """Do x and return foo."""

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

            return config

        def it_detects_failures_in_scripts(config_with_scripts):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
            with pytest.raises(RuntimeError):
                expect(gitman.install())

        def script_failures_can_be_ignored(config_with_scripts):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
            expect(gitman.install(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
          repo: https://github.com/jacebrowning/gitman-demo
          rev: example-branch
          link: ''
          scripts: []
        - name: gitman_2
          repo: https://github.com/jacebrowning/gitman-demo
          rev: example-tag
          link: ''
          scripts: []
        sources_locked:
        - name: gitman_2
          repo: https://github.com/jacebrowning/gitman-demo
          rev: (old revision)
          link: ''
          scripts: []
        """)

        gitman.update(depth=1)

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

    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
          repo: https://github.com/jacebrowning/gitman-demo
          rev: example-branch
          link: ''
          scripts: []
        - name: gitman_2
          repo: https://github.com/jacebrowning/gitman-demo
          rev: example-tag
          link: ''
          scripts: []
        sources_locked:
        - name: gitman_2
          repo: https://github.com/jacebrowning/gitman-demo
          rev: (old revision)
          link: ''
          scripts: []
        """)

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

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

    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
          repo: https://github.com/jacebrowning/gitman-demo
          rev: 1de84ca1d315f81b035cd7b0ecf87ca2025cdacd
          link: ''
          scripts: []
        - name: gitman_2
          repo: https://github.com/jacebrowning/gitman-demo
          rev: 7bd138fe7359561a8c2ff9d195dff238794ccc04
          link: ''
          scripts: []
        - name: gitman_3
          repo: https://github.com/jacebrowning/gitman-demo
          rev: 9bf18e16b956041f0267c21baad555a23237b52e
          link: ''
          scripts: []
        """)


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(TMP, "tmp").replace('\\', '/')
        expect(contents) == strip("""
        2012-01-14 12:00:01
        tmp/deps/gitman_1: https://github.com/jacebrowning/gitman-demo @ 1de84ca1d315f81b035cd7b0ecf87ca2025cdacd
        tmp/deps/gitman_1/gitman_sources/gdm_3: https://github.com/jacebrowning/gdm-demo @ 050290bca3f14e13fd616604202b579853e7bfb0
        tmp/deps/gitman_1/gitman_sources/gdm_3/gitman_sources/gdm_3: https://github.com/jacebrowning/gdm-demo @ fb693447579235391a45ca170959b5583c5042d8
        tmp/deps/gitman_1/gitman_sources/gdm_3/gitman_sources/gdm_4: https://github.com/jacebrowning/gdm-demo @ 63ddfd82d308ddae72d31b61cb8942c898fa05b5
        tmp/deps/gitman_1/gitman_sources/gdm_4: https://github.com/jacebrowning/gdm-demo @ 63ddfd82d308ddae72d31b61cb8942c898fa05b5
        tmp/deps/gitman_2: https://github.com/jacebrowning/gitman-demo @ 7bd138fe7359561a8c2ff9d195dff238794ccc04
        tmp/deps/gitman_3: https://github.com/jacebrowning/gitman-demo @ 9bf18e16b956041f0267c21baad555a23237b52e
        """, 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
          repo: https://github.com/jacebrowning/gitman-demo
          rev: 1de84ca1d315f81b035cd7b0ecf87ca2025cdacd
          link: ''
          scripts: []
        - name: gitman_2
          repo: https://github.com/jacebrowning/gitman-demo
          rev: 7bd138fe7359561a8c2ff9d195dff238794ccc04
          link: ''
          scripts: []
        - name: gitman_3
          repo: https://github.com/jacebrowning/gitman-demo
          rev: 9bf18e16b956041f0267c21baad555a23237b52e
          link: ''
          scripts: []
        """) == 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
          repo: https://github.com/jacebrowning/gitman-demo
          rev: 1de84ca1d315f81b035cd7b0ecf87ca2025cdacd
          link: ''
          scripts: []
        - name: gitman_3
          repo: https://github.com/jacebrowning/gitman-demo
          rev: 9bf18e16b956041f0267c21baad555a23237b52e
          link: ''
          scripts: []
        """) == 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
        shell.rm(os.path.join("deps", "gitman_1", ".project"))

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

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

        finally:
            shell.rm(os.path.join("deps", "gitman_1"))

    def it_should_fail_on_missing_repositories(config):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        shell.mkdir("deps")
        shell.rm(os.path.join("deps", "gitman_1"))

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

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

    def it_should_fail_on_invalid_repositories(config):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        shell.mkdir("deps")
        shell.rm(os.path.join("deps", "gitman_1", ".git"))
        shell.mkdir(os.path.join("deps", "gitman_1", ".git"))

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

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

        finally:
            shell.rm(os.path.join("deps", "gitman_1"))


Pull Request — develop (#148)

it_should_not_overwrite_files() A

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
8			import pytest
9			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...
10			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...
11
12			import gitman
13			from gitman import shell
14			from gitman.models import Config
15			from gitman.exceptions import UncommittedChanges, InvalidRepository
16
17			from .utilities import strip
18
19
20			ROOT = os.path.join(os.path.dirname(os.path.dirname(__file__)))
21			TMP = os.path.join(ROOT, 'tmp')
22
23			CONFIG = """
24			location: deps
25			sources:
26			- name: gitman_1
27			repo: https://github.com/jacebrowning/gitman-demo
28			rev: example-branch
29			link: ''
30			scripts: []
31			- name: gitman_2
32			repo: https://github.com/jacebrowning/gitman-demo
33			rev: example-tag
34			link: ''
35			scripts: []
36			- name: gitman_3
37			repo: https://github.com/jacebrowning/gitman-demo

jacebrowning / gitman

Pull Request — develop (#148)

it_should_not_overwrite_files() A

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