build.setup.read_version_from_json() - Code Metrics - Inspection of "[Release] Bumped 2022.2.0" - kytos-ng/sdntrace - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#27)

by Vinicius

created 2022-08-09 17:19 UTC

build.setup.read_version_from_json() A

↳ Parent: build.setup

Complexity

Conditions

Size

Total Lines	5
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	4
nop	0
dl	0
loc	5
rs	10
c	0
b	0
f	0

"""Setup script.

Run "python3 setup.py --help-commands" to list all available commands and their
descriptions.
"""
import json
import os
import shutil
import sys
from abc import abstractmethod
from pathlib import Path
from subprocess import CalledProcessError, call, check_call

from setuptools import Command, setup
from setuptools.command.develop import develop
from setuptools.command.egg_info import egg_info
from setuptools.command.install import install

if "bdist_wheel" in sys.argv:
    raise RuntimeError("This setup.py does not support wheels")

# Paths setup with virtualenv detection
BASE_ENV = Path(os.environ.get("VIRTUAL_ENV", "/"))

NAPP_NAME = "sdntrace"
NAPP_USERNAME = "amlight"

# Kytos var folder
VAR_PATH = BASE_ENV / "var" / "lib" / "kytos"
# Path for enabled NApps
ENABLED_PATH = VAR_PATH / "napps"
# Path to install NApps
INSTALLED_PATH = VAR_PATH / "napps" / ".installed"
CURRENT_DIR = Path(".").resolve()

# NApps enabled by default
ENABLED_NAPPS = [("amlight", "coloring")]


class SimpleCommand(Command):
    """Make Command implementation simpler."""

    user_options = []

    @abstractmethod
    def run(self):
        """Run when command is invoked.

        Use *call* instead of *check_call* to ignore failures.
        """

    def initialize_options(self):
        """Set default values for options."""

    def finalize_options(self):
        """Post-process options."""


# pylint: disable=attribute-defined-outside-init, abstract-method
class TestCommand(Command):
    """Test tags decorators."""

    user_options = [
        ("k=", None, "Specify a pytest -k expression."),
    ]

    def get_args(self):
        """Return args to be used in test command."""
        if self.k:
            return f"-k '{self.k}'"
        return ""

    def initialize_options(self):
        """Set default size and type args."""
        self.k = ""

    def finalize_options(self):
        """Post-process."""
        pass


class Cleaner(SimpleCommand):
    """Custom clean command to tidy up the project root."""

    description = "clean build, dist, pyc and egg from package and docs"

    def run(self):
        """Clean build, dist, pyc and egg from package and docs."""
        call("rm -vrf ./build ./dist ./*.egg-info", shell=True)
        call("find . -name __pycache__ -type d | xargs rm -rf", shell=True)
        call("make -C docs/ clean", shell=True)


class Test(TestCommand):
    """Run all tests."""

    description = "run tests and display results"

    def run(self):
        """Run tests."""
        cmd = f"python3 -m pytest tests/ {self.get_args()}"
        try:
            check_call(cmd, shell=True)
        except CalledProcessError as exc:
            print(exc)
            print("Unit tests failed. Fix the errors above and try again.")
            sys.exit(-1)


class TestCoverage(Test):
    """Display test coverage."""

    description = "run tests and display code coverage"

    def run(self):
        """Run tests quietly and display coverage report."""
        cmd = f"python3 -m pytest --cov=. tests/ {self.get_args()}"
        try:
            check_call(cmd, shell=True)
        except CalledProcessError as exc:
            print(exc)
            print("Coverage tests failed. Fix the errors above and try again.")
            sys.exit(-1)


class Linter(SimpleCommand):
    """Code linters."""

    description = "lint Python source code"

    def run(self):
        """Run yala."""
        print("Yala is running. It may take several seconds...")
        try:
            cmd = "yala *.py tests"
            check_call(cmd, shell=True)
            print("No linter error found.")
        except CalledProcessError:
            print("Linter check failed. Fix the error(s) above and try again.")
            sys.exit(-1)


class KytosInstall:
    """Common code for all install types."""

    @staticmethod
    def enable_core_napps():
        """Enable a NAPP by creating a symlink."""
        (ENABLED_PATH / NAPP_USERNAME).mkdir(parents=True, exist_ok=True)
        for (user, napp) in ENABLED_NAPPS:
            napp_path = Path(user, napp)
            src = ENABLED_PATH / napp_path
            dst = INSTALLED_PATH / napp_path
            symlink_if_different(src, dst)

    def __str__(self):
        return self.__class__.__name__


class InstallMode(install):
    """Create files in var/lib/kytos."""

    description = 'To install NApps, use kytos-utils. Devs, see "develop".'

    def run(self):
        """Direct users to use kytos-utils to install NApps."""
        print(self.description)


class EggInfo(egg_info):
    """Prepare files to be packed."""

    def run(self):
        """Build css."""
        self._install_deps_wheels()
        super().run()

    @staticmethod
    def _install_deps_wheels():
        """Python wheels are much faster (no compiling)."""
        print("Installing dependencies...")
        check_call(
            [
                sys.executable,
                "-m",
                "pip",
                "install",
                "-r",
                "requirements/run.txt",
            ]
        )


class DevelopMode(develop):
    """Recommended setup for kytos-napps developers.

    Instead of copying the files to the expected directories, a symlink is
    created on the system aiming the current source code.
    """

    description = "Install NApps in development mode"

    def run(self):
        """Install the package in a developer mode."""
        super().run()
        if self.uninstall:
            shutil.rmtree(str(ENABLED_PATH), ignore_errors=True)
        else:
            self._create_folder_symlinks()
            KytosInstall.enable_core_napps()

    @staticmethod
    def _create_folder_symlinks():
        """Symlink to all Kytos NApps folders.

        ./napps/kytos/napp_name will generate a link in
        var/lib/kytos/napps/.installed/kytos/napp_name.
        """
        links = INSTALLED_PATH / NAPP_USERNAME
        links.mkdir(parents=True, exist_ok=True)
        code = CURRENT_DIR
        src = links / NAPP_NAME
        symlink_if_different(src, code)

        (ENABLED_PATH / NAPP_USERNAME).mkdir(parents=True, exist_ok=True)
        dst = ENABLED_PATH / Path(NAPP_USERNAME, NAPP_NAME)
        symlink_if_different(dst, src)

    @staticmethod
    def _create_file_symlinks():
        """Symlink to required files."""
        src = ENABLED_PATH / "__init__.py"
        dst = CURRENT_DIR / "__init__.py"
        symlink_if_different(src, dst)


def read_version_from_json():
    """Read the NApp version from NApp kytos.json file."""
    file = Path("kytos.json")
    metadata = json.loads(file.read_text(encoding="utf8"))
    return metadata["version"]


def read_requirements(path="requirements/run.txt"):
    """Read requirements file and return a list."""
    with open(path, "r", encoding="utf8") as file:
        return [
            line.strip()
            for line in file.readlines()
            if not line.startswith("#")
        ]


def symlink_if_different(path, target):
    """Force symlink creation if it points anywhere else."""
    # print(f"symlinking {path} to target: {target}...", end=" ")
    if not path.exists():
        # print(f"path doesn't exist. linking...")
        path.symlink_to(target)
    elif not path.samefile(target):
        # print(f"path exists, but is different. removing and linking...")
        # Exists but points to a different file, so let's replace it
        path.unlink()
        path.symlink_to(target)


setup(
    name=f"{NAPP_USERNAME}_{NAPP_NAME}",
    version=read_version_from_json(),
    description="An OpenFlow Path Trace for the Kytos SDN controller",
    url="http://github.com/kytos-ng/sdntrace",
    author="Jeronimo Bezerra",
    author_email="[email protected]",
    license="MIT",
    install_requires=read_requirements() + ["setuptools >= 59.6.0"],
    packages=[],
    extras_require={
        "dev": [
            "pytest==7.0.0",
            "pytest-cov==3.0.0",
            "pip-tools",
            "yala",
            "tox",
        ],
    },
    cmdclass={
        "clean": Cleaner,
        "coverage": TestCoverage,
        "develop": DevelopMode,
        "install": InstallMode,
        "lint": Linter,
        "egg_info": EggInfo,
        "test": Test,
    },
    zip_safe=False,
    classifiers=[
        "License :: OSI Approved :: MIT License",
        "Operating System :: POSIX :: Linux",
        "Programming Language :: Python :: 3.9",
        "Topic :: System :: Networking",
    ],
)


1			"""Setup script.
2
3			Run "python3 setup.py --help-commands" to list all available commands and their
4			descriptions.
5			"""
6			import json
7			import os
8			import shutil
9			import sys
10			from abc import abstractmethod
11			from pathlib import Path
12			from subprocess import CalledProcessError, call, check_call
13
14			from setuptools import Command, setup
15			from setuptools.command.develop import develop
16			from setuptools.command.egg_info import egg_info
17			from setuptools.command.install import install
18
19			if "bdist_wheel" in sys.argv:
20			raise RuntimeError("This setup.py does not support wheels")
21
22			# Paths setup with virtualenv detection
23			BASE_ENV = Path(os.environ.get("VIRTUAL_ENV", "/"))
24
25			NAPP_NAME = "sdntrace"
26			NAPP_USERNAME = "amlight"
27
28			# Kytos var folder
29			VAR_PATH = BASE_ENV / "var" / "lib" / "kytos"
30			# Path for enabled NApps
31			ENABLED_PATH = VAR_PATH / "napps"
32			# Path to install NApps
33			INSTALLED_PATH = VAR_PATH / "napps" / ".installed"
34			CURRENT_DIR = Path(".").resolve()
35
36			# NApps enabled by default
37			ENABLED_NAPPS = [("amlight", "coloring")]
38
39
40			class SimpleCommand(Command):
41			"""Make Command implementation simpler."""
42
43			user_options = []
44
45			@abstractmethod
46			def run(self):
47			"""Run when command is invoked.
48
49			Use call instead of check_call to ignore failures.
50			"""
51
52			def initialize_options(self):
53			"""Set default values for options."""
54
55			def finalize_options(self):
56			"""Post-process options."""
57
58
59			# pylint: disable=attribute-defined-outside-init, abstract-method
60			class TestCommand(Command):
61			"""Test tags decorators."""
62
63			user_options = [
64			("k=", None, "Specify a pytest -k expression."),
65			]
66
67			def get_args(self):
68			"""Return args to be used in test command."""
69			if self.k:
70			return f"-k '{self.k}'"
71			return ""
72
73			def initialize_options(self):
74			"""Set default size and type args."""
75			self.k = ""
76
77			def finalize_options(self):
78			"""Post-process."""
79			pass
80
81
82			class Cleaner(SimpleCommand):
83			"""Custom clean command to tidy up the project root."""
84
85			description = "clean build, dist, pyc and egg from package and docs"
86
87			def run(self):
88			"""Clean build, dist, pyc and egg from package and docs."""
89			call("rm -vrf ./build ./dist ./*.egg-info", shell=True)
90			call("find . -name __pycache__ -type d \| xargs rm -rf", shell=True)
91			call("make -C docs/ clean", shell=True)
92
93
94			class Test(TestCommand):
95			"""Run all tests."""
96
97			description = "run tests and display results"
98
99			def run(self):
100			"""Run tests."""
101			cmd = f"python3 -m pytest tests/ {self.get_args()}"
102			try:
103			check_call(cmd, shell=True)
104			except CalledProcessError as exc:
105			print(exc)
106			print("Unit tests failed. Fix the errors above and try again.")
107			sys.exit(-1)
108
109
110			class TestCoverage(Test):
111			"""Display test coverage."""
112
113			description = "run tests and display code coverage"
114
115			def run(self):
116			"""Run tests quietly and display coverage report."""
117			cmd = f"python3 -m pytest --cov=. tests/ {self.get_args()}"
118			try:
119			check_call(cmd, shell=True)
120			except CalledProcessError as exc:
121			print(exc)
122			print("Coverage tests failed. Fix the errors above and try again.")
123			sys.exit(-1)
124
125
126			class Linter(SimpleCommand):
127			"""Code linters."""
128
129			description = "lint Python source code"
130
131			def run(self):
132			"""Run yala."""
133			print("Yala is running. It may take several seconds...")
134			try:
135			cmd = "yala *.py tests"
136			check_call(cmd, shell=True)
137			print("No linter error found.")
138			except CalledProcessError:
139			print("Linter check failed. Fix the error(s) above and try again.")
140			sys.exit(-1)
141
142
143			class KytosInstall:
144			"""Common code for all install types."""
145
146			@staticmethod
147			def enable_core_napps():
148			"""Enable a NAPP by creating a symlink."""
149			(ENABLED_PATH / NAPP_USERNAME).mkdir(parents=True, exist_ok=True)
150			for (user, napp) in ENABLED_NAPPS:
151			napp_path = Path(user, napp)
152			src = ENABLED_PATH / napp_path
153			dst = INSTALLED_PATH / napp_path
154			symlink_if_different(src, dst)
155
156			def __str__(self):
157			return self.__class__.__name__
158
159
160			class InstallMode(install):
161			"""Create files in var/lib/kytos."""
162
163			description = 'To install NApps, use kytos-utils. Devs, see "develop".'
164
165			def run(self):
166			"""Direct users to use kytos-utils to install NApps."""
167			print(self.description)
168
169
170			class EggInfo(egg_info):
171			"""Prepare files to be packed."""
172
173			def run(self):
174			"""Build css."""
175			self._install_deps_wheels()
176			super().run()
177
178			@staticmethod
179			def _install_deps_wheels():
180			"""Python wheels are much faster (no compiling)."""
181			print("Installing dependencies...")
182			check_call(
183			[
184			sys.executable,
185			"-m",
186			"pip",
187			"install",
188			"-r",
189			"requirements/run.txt",
190			]
191			)
192
193
194			class DevelopMode(develop):
195			"""Recommended setup for kytos-napps developers.
196
197			Instead of copying the files to the expected directories, a symlink is
198			created on the system aiming the current source code.
199			"""
200
201			description = "Install NApps in development mode"
202
203			def run(self):
204			"""Install the package in a developer mode."""
205			super().run()
206			if self.uninstall:
207			shutil.rmtree(str(ENABLED_PATH), ignore_errors=True)
208			else:
209			self._create_folder_symlinks()
210			KytosInstall.enable_core_napps()
211
212			@staticmethod
213			def _create_folder_symlinks():
214			"""Symlink to all Kytos NApps folders.
215
216			./napps/kytos/napp_name will generate a link in
217			var/lib/kytos/napps/.installed/kytos/napp_name.
218			"""
219			links = INSTALLED_PATH / NAPP_USERNAME
220			links.mkdir(parents=True, exist_ok=True)
221			code = CURRENT_DIR
222			src = links / NAPP_NAME
223			symlink_if_different(src, code)
224
225			(ENABLED_PATH / NAPP_USERNAME).mkdir(parents=True, exist_ok=True)
226			dst = ENABLED_PATH / Path(NAPP_USERNAME, NAPP_NAME)
227			symlink_if_different(dst, src)
228
229			@staticmethod
230			def _create_file_symlinks():
231			"""Symlink to required files."""
232			src = ENABLED_PATH / "__init__.py"
233			dst = CURRENT_DIR / "__init__.py"
234			symlink_if_different(src, dst)
235
236
237			def read_version_from_json():
238			"""Read the NApp version from NApp kytos.json file."""
239			file = Path("kytos.json")
240			metadata = json.loads(file.read_text(encoding="utf8"))
241			return metadata["version"]
242
243
244			def read_requirements(path="requirements/run.txt"):
245			"""Read requirements file and return a list."""
246			with open(path, "r", encoding="utf8") as file:
247			return [
248			line.strip()
249			for line in file.readlines()
250			if not line.startswith("#")
251			]
252
253
254			def symlink_if_different(path, target):
255			"""Force symlink creation if it points anywhere else."""
256			# print(f"symlinking {path} to target: {target}...", end=" ")
257			if not path.exists():
258			# print(f"path doesn't exist. linking...")
259			path.symlink_to(target)
260			elif not path.samefile(target):
261			# print(f"path exists, but is different. removing and linking...")
262			# Exists but points to a different file, so let's replace it
263			path.unlink()
264			path.symlink_to(target)
265
266
267			setup(
268			name=f"{NAPP_USERNAME}_{NAPP_NAME}",
269			version=read_version_from_json(),
270			description="An OpenFlow Path Trace for the Kytos SDN controller",
271			url="http://github.com/kytos-ng/sdntrace",
272			author="Jeronimo Bezerra",
273			author_email="[email protected]",
274			license="MIT",
275			install_requires=read_requirements() + ["setuptools >= 59.6.0"],
276			packages=[],
277			extras_require={
278			"dev": [
279			"pytest==7.0.0",
280			"pytest-cov==3.0.0",
281			"pip-tools",
282			"yala",
283			"tox",
284			],
285			},
286			cmdclass={
287			"clean": Cleaner,
288			"coverage": TestCoverage,
289			"develop": DevelopMode,
290			"install": InstallMode,
291			"lint": Linter,
292			"egg_info": EggInfo,
293			"test": Test,
294			},
295			zip_safe=False,
296			classifiers=[
297			"License :: OSI Approved :: MIT License",
298			"Operating System :: POSIX :: Linux",
299			"Programming Language :: Python :: 3.9",
300			"Topic :: System :: Networking",
301			],
302			)
303

kytos-ng / sdntrace

Pull Request — master (#27)

build.setup.read_version_from_json() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like