PKG: separate building process from setup.py

move the building process from setup.py to a separate file, make it an
executable
ship the apache configuration file if possible
adapt the debian build rules

Author: Sebastian Wagner

MANIFEST.in

@@ -4,4 +4,6 @@
 include CHANGELOG.md CONTRIBUTING.md CONTRIBUTORS.md
 include NEWS.md README.md SECURITY.md
 include LICENSES/*
-recursive-include docs *
+recursive-include contrib *
+graft intelmq_manager/templates/
+graft intelmq_manager/static/

debian/changelog

@@ -1,4 +1,4 @@
-intelmq-manager (3.1.0~apha1-1) UNRELEASED; urgency=medium
+intelmq-manager (3.1.0~alpha2-1) UNRELEASED; urgency=medium
 
   * Update to 3.1.0.
 

debian/rules

@@ -2,6 +2,13 @@
 %:
 	dh $@ --with python3 --buildsystem=pybuild
 
+override_dh_install:
+	dh_install
+	# build the files. call build.py directly, not the produced executable as that would require an installed instance of intelmq-manager already
+	PYTHONPATH=. python3 ./intelmq_manager/build.py --output-dir debian/intelmq-manager/usr/share/intelmq_manager/html/
+	# remove the generated intelmq-manager-build executable, as it should not be called in deb-installations
+	rm debian/intelmq-manager/usr/bin/intelmq-manager-build
+
 
 override_dh_auto_clean:
 	dh_auto_clean

intelmq_manager/__init__.py

@@ -5,5 +5,6 @@
 
 """
 import pathlib
+from .version import __version__, __version_info__  # noqa
 
 path = pathlib.Path(__file__).parent

intelmq_manager/build.py

@@ -0,0 +1,60 @@
+"""
+Build statically rendered files.
+
+SPDX-FileCopyrightText: 2021 Birger Schacht <schacht@cert.at>, Mikk Margus Möll <mikk@cert.ee>, Sebastian Wagner <wagner@cert.at>
+SPDX-License-Identifier: AGPL-3.0-or-later
+"""
+import argparse
+import pathlib
+import shutil
+from mako.lookup import TemplateLookup
+
+
+def render_page(pagename: str, **template_args) -> str:
+    template_dir = pathlib.Path(__file__).parent / 'templates'
+    template_lookup = TemplateLookup(directories=[template_dir], default_filters=["h"], input_encoding='utf8')
+    template = template_lookup.get_template(f'{pagename}.mako')
+
+    return template.render(pagename=pagename, **template_args)
+
+
+def buildhtml(outputdir: pathlib.Path = pathlib.Path('html')):
+    outputdir.mkdir(parents=True, exist_ok=True)
+
+    htmlfiles = ["configs", "management", "monitor", "check", "about", "index"]
+    for filename in htmlfiles:
+        print(f"Rendering {filename}.html")
+        html = render_page(filename)
+        outputdir.joinpath(f"{filename}.html").write_text(html)
+
+    staticfiles = ["css", "images", "js", "plugins", "less"]
+    for filename in staticfiles:
+        print(f"Copying {filename} recursively")
+        src = pathlib.Path(__file__).parent / 'static' / filename
+        dst = outputdir / filename
+        if dst.exists():
+            shutil.rmtree(dst)
+        shutil.copytree(src, dst)
+
+    print('rendering dynvar.js')
+    rendered = render_page('dynvar', allowed_path='/opt/intelmq/var/lib/bots/', controller_cmd='intelmq')
+    outputdir.joinpath('js/dynvar.js').write_text(rendered)
+
+
+def main():
+    parser = argparse.ArgumentParser(
+        prog='intelmq-manager-build',
+        description='Build statically rendered files for intelmq-manager.',
+        epilog='This command renders and saves all files required for IntelMQ Manager at the given directory, which can be served by Webservers statically',
+        formatter_class=argparse.RawDescriptionHelpFormatter,
+    )
+
+    parser.add_argument('--output-dir', '-o', default='html',
+                        type=pathlib.Path,
+                        help='The destination directory, will be created if needed.')
+    args = parser.parse_args()
+    buildhtml(outputdir=args.output_dir)
+
+
+if __name__ == '__main__':
+    main()

intelmq_manager/manager-apache.conf

@@ -0,0 +1 @@
+../contrib/manager-apache.conf

intelmq_manager/static/js/about.js

@@ -12,7 +12,7 @@ function get_versions() {
         .done(function (data) {
             intelmq_version_element.innerHTML = data.intelmq;
             intelmq_api_version_element.innerHTML = data['intelmq-api'];
-            intelmq_manager_version_element.innerHTML = '3.1.0alpha1';
+            intelmq_manager_version_element.innerHTML = '3.1.0.alpha2';
         })
         .fail(function (jqxhr, textStatus, error) {
             let err = `${textStatus}, ${error}`;

intelmq_manager/version.py

@@ -3,5 +3,5 @@
 SPDX-FileCopyrightText: 2020-2021 Intelmq Team <intelmq-team@cert.at>
 SPDX-License-Identifier: AGPL-3.0-or-later
 """
-__version_info__ = (3, 1, 0, 'alpha1')
+__version_info__ = (3, 1, 0, 'alpha2')
 __version__ = '.'.join(map(str, __version_info__))

setup.py

@@ -1,65 +1,56 @@
-""" Setup file for intelmq-manager
+"""
+Setup file for intelmq-manager
 
 SPDX-FileCopyrightText: 2020 IntelMQ Team <intelmq-team@cert.at>
 SPDX-License-Identifier: AGPL-3.0-or-later
 """
-from setuptools import find_packages, setup
 
-import pathlib
-import shutil
-from mako.lookup import TemplateLookup
+from setuptools import find_packages, setup
 
 from intelmq_manager.version import __version__
 
-def render_page(pagename:str, **template_args) -> str:
-    template_dir = pathlib.Path('intelmq_manager/templates')
-    template_lookup = TemplateLookup(directories=[template_dir], default_filters=["h"], input_encoding='utf8')
-    template = template_lookup.get_template(f'{pagename}.mako')
-
-    return template.render(pagename=pagename, **template_args)
-
-def buildhtml():
-    outputdir = pathlib.Path('html')
-    outputdir.mkdir(parents=True, exist_ok=True)
-
-    htmlfiles = ["configs", "management", "monitor", "check", "about", "index"]
-    for filename in htmlfiles:
-        print(f"Rendering {filename}.html")
-        html = render_page(filename)
-        outputdir.joinpath(f"{filename}.html").write_text(html)
-
-    staticfiles = ["css", "images", "js", "plugins", "less"]
-    for filename in staticfiles:
-        print(f"Copying {filename} recursively")
-        src = pathlib.Path('intelmq_manager/static') / filename
-        dst = outputdir / filename
-        if dst.exists():
-            shutil.rmtree(dst)
-        shutil.copytree(src, dst)
-
-    print('rendering dynvar.js')
-    rendered = render_page('dynvar', allowed_path='/opt/intelmq/var/lib/bots/', controller_cmd='intelmq')
-    outputdir.joinpath('js/dynvar.js').write_text(rendered)
-
-# Before running setup, we build the html files in any case
-buildhtml()
-
-htmlsubdirs = [directory for directory in pathlib.Path('html').glob('**') if directory.is_dir()]
-data_files = [(f'/usr/share/intelmq_manager/{directory}', [str(x) for x in directory.glob('*') if x.is_file()]) for directory in htmlsubdirs]
-data_files = data_files + [('/usr/share/intelmq_manager/html', [str(x) for x in pathlib.Path('html').iterdir() if x.is_file()])]
-data_files = data_files + [('/etc/intelmq', ['contrib/manager-apache.conf'])]
 
 setup(
     name="intelmq-manager",
+    maintainer='IntelMQ Team',
+    maintainer_email='intelmq-team@cert.at',
     version=__version__,
     python_requires='>=3.5',
     packages=find_packages(),
     install_requires=[
         "intelmq-api",
+        "mako",
     ],
     include_package_data=True,
     url='https://github.com/certtools/intelmq-manager/',
     description=("IntelMQ Manager is a graphical interface to manage"
                  " configurations for the IntelMQ framework."),
-    data_files=data_files
+    data_files=[('/etc/intelmq', ['contrib/manager-apache.conf'])],  # required for deb packaging
+    package_data={'': ('manager-apache.conf',  # works for the wheel package
+                       'templates/*',
+                       'static/css/*',
+                       'static/images/*',
+                       'static/js/*',
+                       'static/less/*',
+                       'static/plugins/*',
+                       'static/plugins/bootstrap/*',
+                       'static/plugins/dataTables/*',
+                       'static/plugins/font-awesome-4.1.0/*',
+                       'static/plugins/font-awesome-4.1.0/css/*',
+                       'static/plugins/font-awesome-4.1.0/fonts/*',
+                       'static/plugins/font-awesome-4.1.0/less/*',
+                       'static/plugins/font-awesome-4.1.0/scss/*',
+                       'static/plugins/fonts/*',
+                       'static/plugins/metisMenu/*',
+                       'static/plugins/vis.js/*',
+                       'static/plugins/vis.js/img/*',
+                       'static/plugins/vis.js/img/graph/*',
+                       'static/plugins/vis.js/img/network/*',
+                       'static/plugins/vis.js/img/timeline/*',
+                       )},
+    entry_points={
+        'console_scripts': [
+            'intelmq-manager-build = intelmq_manager.build:main',
+        ],
+    },
 )