buildtimetrend.travis.load_build_matrix_env_vars() - Code Metrics - Inspection of "Merge pull request #135 from buildtimetrend/refact..." - buildtimetrend/python-lib - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 219e97...2114cf )

by Dieter

created 2015-12-29 09:56 UTC

buildtimetrend.travis.load_build_matrix_env_vars() C

↳ Parent: Project

Complexity

Conditions

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Metric	Value
cc	8
dl	0
loc	65
rs	5.4815

How to fix Long Method

# vim: set expandtab sw=4 ts=4:
"""
Travis CI environment variable loading functions.

Copyright (C) 2014-2015 Dieter Adriaenssens <[email protected]>

This file is part of buildtimetrend/python-lib
<https://github.com/buildtimetrend/python-lib/>

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by
the Free Software Foundation, either version 3 of the License, or
any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
"""
from builtins import str
from builtins import object

import os
from buildtimetrend.settings import Settings
from buildtimetrend.collection import Collection
from buildtimetrend.travis.tools import convert_build_result


def load_all(settings=None):
    """
    Load all Travis CI environment variables.

    Load Travis CI environment variables and assign their values to
    the corresponding setting value :
    - general
    - build matrix
    - pull request
    """
    if not isinstance(settings, Settings):
        settings = Settings()

    load_general_env_vars(settings)
    load_build_matrix_env_vars(settings)
    load_travis_pr_env_vars(settings)


def load_general_env_vars(settings):
    """
    Load Travis CI environment variables.

    Load Travis CI environment variables and assign their values to
    the corresponding setting value.
    """
    if "TRAVIS" in os.environ and os.environ["TRAVIS"] == "true":
        # set ci_platform setting to "travis"
        settings.add_setting("ci_platform", "travis")

        # assign TRAVIS environment variable values to setting value
        settings.env_var_to_settings("TRAVIS_BUILD_NUMBER", "build")
        settings.env_var_to_settings("TRAVIS_JOB_NUMBER", "job")
        settings.env_var_to_settings("TRAVIS_BRANCH", "branch")
        settings.env_var_to_settings("TRAVIS_REPO_SLUG", "project_name")

        # convert and set Travis build result
        if "TRAVIS_TEST_RESULT" in os.environ:
            # map $TRAVIS_TEST_RESULT to a more readable value
            settings.add_setting(
                "result",
                convert_build_result(os.environ["TRAVIS_TEST_RESULT"])
            )


def load_build_matrix_env_vars(settings):
    """
    Retrieve build matrix data from environment variables.

    Load Travis CI build matrix environment variables
    and assign their values to the corresponding setting value.

    Properties :
    - language
    - language version (if applicable)
    - compiler (if applicable)
    - operating system
    - environment parameters

    Parameters:
    - settings: Settings instance
    """
    if "TRAVIS" in os.environ and os.environ["TRAVIS"] == "true":
        build_matrix = Collection()

        if "TRAVIS_OS_NAME" in os.environ:
            build_matrix.add_item("os", os.environ["TRAVIS_OS_NAME"])

        # set language and language version
        language_env_vars = {
            'TRAVIS_DART_VERSION': 'dart',
            'TRAVIS_GO_VERSION': 'go',
            'TRAVIS_HAXE_VERSION': 'haxe',
            'TRAVIS_JDK_VERSION': 'java',
            'TRAVIS_JULIA_VERSION': 'julia',
            'TRAVIS_NODE_VERSION': 'javascript',
            'TRAVIS_OTP_RELEASE': 'erlang',
            'TRAVIS_PERL_VERSION': 'perl',
            'TRAVIS_PHP_VERSION': 'php',
            'TRAVIS_PYTHON_VERSION': 'python',
            'TRAVIS_R_VERSION': 'r',
            'TRAVIS_RUBY_VERSION': 'ruby',
            'TRAVIS_RUST_VERSION': 'rust',
            'TRAVIS_SCALA_VERSION': 'scala'
        }
        for env_var, language in language_env_vars.items():
            if env_var in os.environ:
                build_matrix.add_item("language", language)
                build_matrix.add_item(
                    "language_version",
                    str(os.environ[env_var])
                )

        # language specific build matrix parameters
        parameters = {
            'TRAVIS_XCODE_SDK': 'xcode_sdk',  # Objective-C
            'TRAVIS_XCODE_SCHEME': 'xcode_scheme',  # Objective-C
            'TRAVIS_XCODE_PROJECT': 'xcode_project',  # Objective-C
            'TRAVIS_XCODE_WORKSPACE': 'xcode_workspace',  # Objective-C
            'CC': 'compiler',  # C, C++
            'ENV': 'parameters'
        }

        for parameter, name in parameters.items():
            if parameter in os.environ:
                build_matrix.add_item(name, str(os.environ[parameter]))

        settings.add_setting(
            "build_matrix",
            build_matrix.get_items_with_summary()
        )


def load_travis_pr_env_vars(settings):
    """
    Load Travis CI pull request environment variables.

    Load Travis CI pull request environment variables
    and assign their values to the corresponding setting value.
    """
    if "TRAVIS" in os.environ and os.environ["TRAVIS"] == "true" and \
            "TRAVIS_PULL_REQUEST" in os.environ and \
            not os.environ["TRAVIS_PULL_REQUEST"] == "false":
        settings.add_setting("build_trigger", "pull_request")
        settings.add_setting(
            "pull_request",
            {
                'is_pull_request': True,
                'title': "unknown",
                'number': os.environ["TRAVIS_PULL_REQUEST"]
            }
        )
    else:
        settings.add_setting("build_trigger", "push")
        settings.add_setting(
            "pull_request",
            {
                'is_pull_request': False,
                'title': None,
                'number': None
            }
        )


1			# vim: set expandtab sw=4 ts=4:
2			"""
3			Travis CI environment variable loading functions.
4
5			Copyright (C) 2014-2015 Dieter Adriaenssens <[email protected]>
6
7			This file is part of buildtimetrend/python-lib
8			<https://github.com/buildtimetrend/python-lib/>
9
10			This program is free software: you can redistribute it and/or modify
11			it under the terms of the GNU Affero General Public License as published by
12			the Free Software Foundation, either version 3 of the License, or
13			any later version.
14
15			This program is distributed in the hope that it will be useful,
16			but WITHOUT ANY WARRANTY; without even the implied warranty of
17			MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18			GNU Affero General Public License for more details.
19
20			You should have received a copy of the GNU Affero General Public License
21			along with this program. If not, see <http://www.gnu.org/licenses/>.
22			"""
23			from builtins import str
24			from builtins import object
			0 ignored issues – show Unused Code introduced 2015-12-26 20:49 UTC by Report Bug Copy Issue Report Unused object imported from builtins Loading history...
25			import os
26			from buildtimetrend.settings import Settings
27			from buildtimetrend.collection import Collection
28			from buildtimetrend.travis.tools import convert_build_result
29
30
31			def load_all(settings=None):
32			"""
33			Load all Travis CI environment variables.
34
35			Load Travis CI environment variables and assign their values to
36			the corresponding setting value :
37			- general
38			- build matrix
39			- pull request
40			"""
41			if not isinstance(settings, Settings):
42			settings = Settings()
43
44			load_general_env_vars(settings)
45			load_build_matrix_env_vars(settings)
46			load_travis_pr_env_vars(settings)
47
48
49			def load_general_env_vars(settings):
50			"""
51			Load Travis CI environment variables.
52
53			Load Travis CI environment variables and assign their values to
54			the corresponding setting value.
55			"""
56			if "TRAVIS" in os.environ and os.environ["TRAVIS"] == "true":
57			# set ci_platform setting to "travis"
58			settings.add_setting("ci_platform", "travis")
59
60			# assign TRAVIS environment variable values to setting value
61			settings.env_var_to_settings("TRAVIS_BUILD_NUMBER", "build")
62			settings.env_var_to_settings("TRAVIS_JOB_NUMBER", "job")
63			settings.env_var_to_settings("TRAVIS_BRANCH", "branch")
64			settings.env_var_to_settings("TRAVIS_REPO_SLUG", "project_name")
65
66			# convert and set Travis build result
67			if "TRAVIS_TEST_RESULT" in os.environ:
68			# map $TRAVIS_TEST_RESULT to a more readable value
69			settings.add_setting(
70			"result",
71			convert_build_result(os.environ["TRAVIS_TEST_RESULT"])
72			)
73
74
75			def load_build_matrix_env_vars(settings):
76			"""
77			Retrieve build matrix data from environment variables.
78
79			Load Travis CI build matrix environment variables
80			and assign their values to the corresponding setting value.
81
82			Properties :
83			- language
84			- language version (if applicable)
85			- compiler (if applicable)
86			- operating system
87			- environment parameters
88
89			Parameters:
90			- settings: Settings instance
91			"""
92			if "TRAVIS" in os.environ and os.environ["TRAVIS"] == "true":
93			build_matrix = Collection()
94
95			if "TRAVIS_OS_NAME" in os.environ:
96			build_matrix.add_item("os", os.environ["TRAVIS_OS_NAME"])
97
98			# set language and language version
99			language_env_vars = {
100			'TRAVIS_DART_VERSION': 'dart',
101			'TRAVIS_GO_VERSION': 'go',
102			'TRAVIS_HAXE_VERSION': 'haxe',
103			'TRAVIS_JDK_VERSION': 'java',
104			'TRAVIS_JULIA_VERSION': 'julia',
105			'TRAVIS_NODE_VERSION': 'javascript',
106			'TRAVIS_OTP_RELEASE': 'erlang',
107			'TRAVIS_PERL_VERSION': 'perl',
108			'TRAVIS_PHP_VERSION': 'php',
109			'TRAVIS_PYTHON_VERSION': 'python',
110			'TRAVIS_R_VERSION': 'r',
111			'TRAVIS_RUBY_VERSION': 'ruby',
112			'TRAVIS_RUST_VERSION': 'rust',
113			'TRAVIS_SCALA_VERSION': 'scala'
114			}
115			for env_var, language in language_env_vars.items():
116			if env_var in os.environ:
117			build_matrix.add_item("language", language)
118			build_matrix.add_item(
119			"language_version",
120			str(os.environ[env_var])
121			)
122
123			# language specific build matrix parameters
124			parameters = {
125			'TRAVIS_XCODE_SDK': 'xcode_sdk', # Objective-C
126			'TRAVIS_XCODE_SCHEME': 'xcode_scheme', # Objective-C
127			'TRAVIS_XCODE_PROJECT': 'xcode_project', # Objective-C
128			'TRAVIS_XCODE_WORKSPACE': 'xcode_workspace', # Objective-C
129			'CC': 'compiler', # C, C++
130			'ENV': 'parameters'
131			}
132
133			for parameter, name in parameters.items():
134			if parameter in os.environ:
135			build_matrix.add_item(name, str(os.environ[parameter]))
136
137			settings.add_setting(
138			"build_matrix",
139			build_matrix.get_items_with_summary()
140			)
141
142
143			def load_travis_pr_env_vars(settings):
144			"""
145			Load Travis CI pull request environment variables.
146
147			Load Travis CI pull request environment variables
148			and assign their values to the corresponding setting value.
149			"""
150			if "TRAVIS" in os.environ and os.environ["TRAVIS"] == "true" and \
151			"TRAVIS_PULL_REQUEST" in os.environ and \
152			not os.environ["TRAVIS_PULL_REQUEST"] == "false":
153			settings.add_setting("build_trigger", "pull_request")
154			settings.add_setting(
155			"pull_request",
156			{
157			'is_pull_request': True,
158			'title': "unknown",
159			'number': os.environ["TRAVIS_PULL_REQUEST"]
160			}
161			)
162			else:
163			settings.add_setting("build_trigger", "push")
164			settings.add_setting(
165			"pull_request",
166			{
167			'is_pull_request': False,
168			'title': None,
169			'number': None
170			}
171			)
172

buildtimetrend / python-lib

Push — master ( 219e97...2114cf )

buildtimetrend.travis.load_build_matrix_env_vars() C

Complexity

Size

Duplication

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like