1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
|
"""Setup script.
Run "python3 setup --help-commands" to list all available commands and their
descriptions.
"""
import os
import re
import shutil
import sys
from abc import abstractmethod
# Disabling checks due to https://github.com/PyCQA/pylint/issues/73
from distutils.command.clean import clean # pylint: disable=E0401,E0611
from subprocess import CalledProcessError, call, check_call
from setuptools import Command, find_packages, setup
from setuptools.command.develop import develop
from setuptools.command.install import install
if 'VIRTUAL_ENV' in os.environ:
BASE_ENV = os.environ['VIRTUAL_ENV']
else:
BASE_ENV = ''
ETC_KYTOS = 'etc/kytos'
KYTOS_SKEL_PATH = 'etc/kytos/skel'
USERNAME_PATH = os.path.join(KYTOS_SKEL_PATH, 'napp-structure/username')
NAPP_PATH = os.path.join(USERNAME_PATH, 'napp')
ETC_FILES = [(os.path.join(BASE_ENV, USERNAME_PATH),
[os.path.join(USERNAME_PATH, '__init__.py')]),
(os.path.join(BASE_ENV, NAPP_PATH),
[os.path.join(NAPP_PATH, '__init__.py.template'),
os.path.join(NAPP_PATH, 'kytos.json.template'),
os.path.join(NAPP_PATH, 'openapi.yml.template'),
os.path.join(NAPP_PATH, 'main.py.template'),
os.path.join(NAPP_PATH, 'README.rst.template'),
os.path.join(NAPP_PATH, 'settings.py.template')])]
class SimpleCommand(Command):
"""Make Command implementation simpler."""
user_options = []
def __init__(self, *args, **kwargs):
"""Store arguments so it's possible to call other commands later."""
super().__init__(*args, **kwargs)
self._args = args
self._kwargs = kwargs
@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."""
class Cleaner(clean):
"""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."""
super().run()
call('rm -vrf ./build ./dist ./*.egg-info', shell=True)
call('find . -name __pycache__ -type d | xargs rm -rf', shell=True)
call('test -d docs && make -C docs/ clean', shell=True)
class TestCoverage(SimpleCommand):
"""Display test coverage."""
description = 'run unit tests and display code coverage'
def run(self):
"""Run unittest quietly and display coverage report."""
cmd = 'coverage3 run --source=kytos setup.py test && coverage3 report'
check_call(cmd, shell=True)
class CITest(SimpleCommand):
"""Run all CI tests."""
description = 'run all CI tests: unit and doc tests, linter'
def run(self):
"""Run unit tests with coverage, doc tests and linter."""
for command in TestCoverage, Linter:
command(*self._args, **self._kwargs).run()
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:
check_call('yala setup.py tests kytos', 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 CommonInstall:
"""Class with common procedures to install the package."""
@staticmethod
def _create_data_files_directory(symlink=False):
"""Install data_files in the /etc directory."""
current_directory = os.path.abspath(os.path.dirname(__file__))
etc_kytos = os.path.join(BASE_ENV, ETC_KYTOS)
if not os.path.exists(etc_kytos):
os.makedirs(etc_kytos)
src = os.path.join(current_directory, KYTOS_SKEL_PATH)
dst = os.path.join(BASE_ENV, KYTOS_SKEL_PATH)
if os.path.exists(dst):
if not os.listdir(dst):
# Path already exists but it's empty, so we'll populate it
# We remove it first to avoid an exception from copytree
os.rmdir(dst)
shutil.copytree(src, dst)
else:
# It doesn't exist yet, so we should symlink or copy contents
if symlink:
os.symlink(src, dst)
else:
shutil.copytree(src, dst)
class InstallMode(install, CommonInstall):
"""Procedures to install the package."""
def run(self):
"""Install the package in a developer mode."""
super().run()
self._create_data_files_directory()
class DevelopMode(develop, CommonInstall):
"""Recommended setup for kytos-utils developers.
Instead of copying the files to the expected directories, a symlink is
created on the system aiming the current source code.
"""
def run(self):
"""Install the package in a developer mode."""
super().run()
self._create_data_files_directory(True)
# We are parsing the metadata file as if it was a text file because if we
# import it as a python module, necessarily the kytos.utils module would be
# initialized.
META_FILE = open("kytos/utils/metadata.py").read()
METADATA = dict(re.findall(r"(__[a-z]+__)\s*=\s*'([^']+)'", META_FILE))
setup(name='kytos-utils',
version=METADATA.get('__version__'),
description=METADATA.get('__description__'),
url=METADATA.get('__url__'),
author=METADATA.get('__author__'),
author_email=METADATA.get('__author_email__'),
license=METADATA.get('__license__'),
test_suite='tests',
include_package_data=True,
scripts=['bin/kytos'],
install_requires=[line.strip()
for line in open("requirements/run.txt").readlines()
if not line.startswith('#')],
packages=find_packages(exclude=['tests']),
cmdclass={
'ci': CITest,
'clean': Cleaner,
'coverage': TestCoverage,
'develop': DevelopMode,
'install': InstallMode,
'lint': Linter
},
zip_safe=False)
|
