Added post_install method for building Docker images for backends (fixes

squaresLab · Jan 30, 2020 · d02d367 · d02d367
1 parent 76ee80d
commit d02d367
Show file tree

Hide file tree

Showing 64 changed files with 87 additions and 33 deletions.
diff --git a/Dockerfile.debug b/Dockerfile.debug
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -0,0 +1 @@
+graft lib/kaskara/clang/backend
diff --git a/README.rst b/README.rst
@@ -17,8 +17,21 @@ A simple, unified API for performing static analysis on programs in a variety
 of languages. Kaskara avoids dependency hell when analysing programs by making
 use of Docker.
 
-* Kaskara currently provides C and C++ analysis support via its Clang driver.
-* Python analysis support is planned for the end of December 2019.
-
+* Kaskara currently provides C and C++ analysis support via its Clang driver,
+* As of January 2020, Kaskara now provides support for Python analysis.
+* Support for analysis of Java code is planned for February 2020.
 
 .. image:: https://upload.wikimedia.org/wikipedia/commons/f/fc/Kaskara-Sword.jpg
+
+
+Post-Installation
+-----------------
+
+After installing the `kaskara` package as a dependency of your project, you
+should execute the following code to complete the installation by building the
+support backends:
+
+.. code:: python
+  
+    import kaskara
+    kaskara.post_install()
diff --git a/debug.sh b/debug.sh
diff --git a/python/kaskara/__init__.py → lib/kaskara/__init__.py b/python/kaskara/__init__.py → lib/kaskara/__init__.py
@@ -9,7 +9,9 @@
 from .insertions import InsertionPoint
 from .statements import Statement
 from .loops import ProgramLoops
+from .post_install import post_install
 from . import clang
 from . import python
 
+
 _logger.disable('kaskara')
diff --git a/python/kaskara/analyser.py → lib/kaskara/analyser.py b/python/kaskara/analyser.py → lib/kaskara/analyser.py
diff --git a/python/kaskara/analysis.py → lib/kaskara/analysis.py b/python/kaskara/analysis.py → lib/kaskara/analysis.py
diff --git a/python/kaskara/clang/__init__.py → lib/kaskara/clang/__init__.py b/python/kaskara/clang/__init__.py → lib/kaskara/clang/__init__.py
@@ -1,3 +1,4 @@
 # -*- coding: utf-8 -*-
 from .analysis import ClangFunction
 from .analyser import ClangAnalyser
+from .post_install import post_install
diff --git a/python/kaskara/clang/analyser.py → lib/kaskara/clang/analyser.py b/python/kaskara/clang/analyser.py → lib/kaskara/clang/analyser.py
diff --git a/python/kaskara/clang/analysis.py → lib/kaskara/clang/analysis.py b/python/kaskara/clang/analysis.py → lib/kaskara/clang/analysis.py
diff --git a/lib/kaskara/clang/backend/.dockerignore b/lib/kaskara/clang/backend/.dockerignore
@@ -0,0 +1,5 @@
+**
+!CMakeLists.txt
+!cmake
+!src
+!scripts
diff --git a/CMakeLists.txt → lib/kaskara/clang/backend/CMakeLists.txt b/CMakeLists.txt → lib/kaskara/clang/backend/CMakeLists.txt
@@ -185,4 +185,4 @@ add_definitions(${CLANG_DEFINITIONS})
 add_definitions(${LLVM_DEFINITIONS})
 add_definitions(-fno-rtti -std=c++17)
 
-add_subdirectory(cpp)
+add_subdirectory(src)
diff --git a/Dockerfile → lib/kaskara/clang/backend/Dockerfile b/Dockerfile → lib/kaskara/clang/backend/Dockerfile
@@ -34,23 +34,20 @@ ADD . /tmp/kaskara
 RUN mkdir /tmp/kaskara/build && \
     cd /tmp/kaskara/build && \
     cmake .. && \
-    make -j $(nproc)
+    make -j4
 RUN mkdir -p /opt/kaskara/bin \
- && cp /tmp/kaskara/build/cpp/kaskara-loop-finder /opt/kaskara/bin \
- && cp /tmp/kaskara/build/cpp/kaskara-statement-finder /opt/kaskara/bin \
- && cp /tmp/kaskara/build/cpp/kaskara-function-scanner /opt/kaskara/bin \
- && cp /tmp/kaskara/build/cpp/kaskara-insertion-point-finder /opt/kaskara/bin \
- && cp /tmp/kaskara/build/cpp/kaskara-snippet-extractor /opt/kaskara/bin
+ && cp /tmp/kaskara/build/src/kaskara-loop-finder /opt/kaskara/bin \
+ && cp /tmp/kaskara/build/src/kaskara-statement-finder /opt/kaskara/bin \
+ && cp /tmp/kaskara/build/src/kaskara-function-scanner /opt/kaskara/bin \
+ && cp /tmp/kaskara/build/src/kaskara-insertion-point-finder /opt/kaskara/bin \
+ && cp /tmp/kaskara/build/src/kaskara-snippet-extractor /opt/kaskara/bin
 RUN mkdir -p /opt/kaskara/clang \
  && cp -r /usr/local/lib/clang/5.0.0/include/* /opt/kaskara/clang
 
 # install scripts
-ADD scripts /opt/kaskara/scripts
-
-FROM alpine:3.7 as python
+FROM alpine:3.7 as minimal
 COPY --from=cpp /opt/kaskara /opt/kaskara
+COPY scripts /opt/kaskara/scripts
 WORKDIR /opt/kaskara
-COPY python /opt/kaskara/python
-COPY setup.py /opt/kaskara
 ENV PATH "/opt/kaskara/scripts:${PATH}"
 VOLUME /opt/kaskara
diff --git a/cmake/FindClang.cmake → ...skara/clang/backend/cmake/FindClang.cmake b/cmake/FindClang.cmake → ...skara/clang/backend/cmake/FindClang.cmake
diff --git a/cmake/FindLLVM.cmake → ...askara/clang/backend/cmake/FindLLVM.cmake b/cmake/FindLLVM.cmake → ...askara/clang/backend/cmake/FindLLVM.cmake
diff --git a/scripts/kaskara-function-scanner → .../backend/scripts/kaskara-function-scanner b/scripts/kaskara-function-scanner → .../backend/scripts/kaskara-function-scanner
diff --git a/scripts/kaskara-insertion-point-finder → ...nd/scripts/kaskara-insertion-point-finder b/scripts/kaskara-insertion-point-finder → ...nd/scripts/kaskara-insertion-point-finder
diff --git a/scripts/kaskara-loop-finder → ...clang/backend/scripts/kaskara-loop-finder b/scripts/kaskara-loop-finder → ...clang/backend/scripts/kaskara-loop-finder
diff --git a/scripts/kaskara-snippet-extractor → ...backend/scripts/kaskara-snippet-extractor b/scripts/kaskara-snippet-extractor → ...backend/scripts/kaskara-snippet-extractor
diff --git a/scripts/kaskara-statement-finder → .../backend/scripts/kaskara-statement-finder b/scripts/kaskara-statement-finder → .../backend/scripts/kaskara-statement-finder
diff --git a/cpp/CMakeLists.txt → lib/kaskara/clang/backend/src/CMakeLists.txt b/cpp/CMakeLists.txt → lib/kaskara/clang/backend/src/CMakeLists.txt
diff --git a/cpp/FunctionDB.cpp → lib/kaskara/clang/backend/src/FunctionDB.cpp b/cpp/FunctionDB.cpp → lib/kaskara/clang/backend/src/FunctionDB.cpp
diff --git a/cpp/FunctionDB.h → lib/kaskara/clang/backend/src/FunctionDB.h b/cpp/FunctionDB.h → lib/kaskara/clang/backend/src/FunctionDB.h
diff --git a/cpp/InsertionPointDB.cpp → ...ra/clang/backend/src/InsertionPointDB.cpp b/cpp/InsertionPointDB.cpp → ...ra/clang/backend/src/InsertionPointDB.cpp
diff --git a/cpp/InsertionPointDB.h → ...kara/clang/backend/src/InsertionPointDB.h b/cpp/InsertionPointDB.h → ...kara/clang/backend/src/InsertionPointDB.h
diff --git a/cpp/LoopDB.cpp → lib/kaskara/clang/backend/src/LoopDB.cpp b/cpp/LoopDB.cpp → lib/kaskara/clang/backend/src/LoopDB.cpp
diff --git a/cpp/LoopDB.h → lib/kaskara/clang/backend/src/LoopDB.h b/cpp/LoopDB.h → lib/kaskara/clang/backend/src/LoopDB.h
diff --git a/cpp/ReadWriteAnalyzer.cpp → ...a/clang/backend/src/ReadWriteAnalyzer.cpp b/cpp/ReadWriteAnalyzer.cpp → ...a/clang/backend/src/ReadWriteAnalyzer.cpp
diff --git a/cpp/ReadWriteAnalyzer.h → ...ara/clang/backend/src/ReadWriteAnalyzer.h b/cpp/ReadWriteAnalyzer.h → ...ara/clang/backend/src/ReadWriteAnalyzer.h
diff --git a/cpp/SnippetDB.cpp → lib/kaskara/clang/backend/src/SnippetDB.cpp b/cpp/SnippetDB.cpp → lib/kaskara/clang/backend/src/SnippetDB.cpp
diff --git a/cpp/SnippetDB.h → lib/kaskara/clang/backend/src/SnippetDB.h b/cpp/SnippetDB.h → lib/kaskara/clang/backend/src/SnippetDB.h
diff --git a/cpp/StatementDB.cpp → ...kaskara/clang/backend/src/StatementDB.cpp b/cpp/StatementDB.cpp → ...kaskara/clang/backend/src/StatementDB.cpp
diff --git a/cpp/StatementDB.h → lib/kaskara/clang/backend/src/StatementDB.h b/cpp/StatementDB.h → lib/kaskara/clang/backend/src/StatementDB.h
diff --git a/cpp/SyntaxScopeAnalyzer.cpp → ...clang/backend/src/SyntaxScopeAnalyzer.cpp b/cpp/SyntaxScopeAnalyzer.cpp → ...clang/backend/src/SyntaxScopeAnalyzer.cpp
diff --git a/cpp/SyntaxScopeAnalyzer.h → ...a/clang/backend/src/SyntaxScopeAnalyzer.h b/cpp/SyntaxScopeAnalyzer.h → ...a/clang/backend/src/SyntaxScopeAnalyzer.h
diff --git a/cpp/function-scanner.cpp → ...ra/clang/backend/src/function-scanner.cpp b/cpp/function-scanner.cpp → ...ra/clang/backend/src/function-scanner.cpp
diff --git a/cpp/insertion-point-finder.cpp → ...ng/backend/src/insertion-point-finder.cpp b/cpp/insertion-point-finder.cpp → ...ng/backend/src/insertion-point-finder.cpp
diff --git a/cpp/loop-finder.cpp → ...kaskara/clang/backend/src/loop-finder.cpp b/cpp/loop-finder.cpp → ...kaskara/clang/backend/src/loop-finder.cpp
diff --git a/cpp/main.cpp → lib/kaskara/clang/backend/src/main.cpp b/cpp/main.cpp → lib/kaskara/clang/backend/src/main.cpp
diff --git a/cpp/snippet-extractor.cpp → ...a/clang/backend/src/snippet-extractor.cpp b/cpp/snippet-extractor.cpp → ...a/clang/backend/src/snippet-extractor.cpp
diff --git a/cpp/statement-finder.cpp → ...ra/clang/backend/src/statement-finder.cpp b/cpp/statement-finder.cpp → ...ra/clang/backend/src/statement-finder.cpp
diff --git a/cpp/util.cpp → lib/kaskara/clang/backend/src/util.cpp b/cpp/util.cpp → lib/kaskara/clang/backend/src/util.cpp
diff --git a/cpp/util.h → lib/kaskara/clang/backend/src/util.h b/cpp/util.h → lib/kaskara/clang/backend/src/util.h
diff --git a/lib/kaskara/clang/post_install.py b/lib/kaskara/clang/post_install.py
@@ -0,0 +1,27 @@
+# -*- coding: utf-8 -*-
+"""
+This module is responsible for installing the backend for the C++ plugin.
+"""
+__all__ = ('post_install,')
+
+import contextlib
+import pkg_resources
+
+from loguru import logger
+import docker
+
+IMAGE_NAME: str = 'christimperley/kaskara:cpp'
+
+
+def post_install() -> None:
+    """Installs the C++ plugin backend."""
+    logger.info('installing C++ plugin backend')
+    backend_directory = pkg_resources.resource_filename(__name__, 'backend')
+    logger.debug(f'backend located at: {backend_directory}')
+    with contextlib.closing(docker.from_env()) as docker_client:
+        logger.debug('prepared Docker client for C++ backend installation')
+        image, _ = docker_client.images.build(path=backend_directory,
+                                              tag=IMAGE_NAME,
+                                              pull=True)
+        logger.info(f"built Docker image for C++ plugin: {image.tags}")
+    logger.info('installed C++ plugin backend')
diff --git a/python/kaskara/container.py → lib/kaskara/container.py b/python/kaskara/container.py → lib/kaskara/container.py
diff --git a/python/kaskara/core.py → lib/kaskara/core.py b/python/kaskara/core.py → lib/kaskara/core.py
diff --git a/python/kaskara/exceptions.py → lib/kaskara/exceptions.py b/python/kaskara/exceptions.py → lib/kaskara/exceptions.py
diff --git a/python/kaskara/functions.py → lib/kaskara/functions.py b/python/kaskara/functions.py → lib/kaskara/functions.py
diff --git a/python/kaskara/insertions.py → lib/kaskara/insertions.py b/python/kaskara/insertions.py → lib/kaskara/insertions.py
diff --git a/python/kaskara/loops.py → lib/kaskara/loops.py b/python/kaskara/loops.py → lib/kaskara/loops.py
diff --git a/lib/kaskara/post_install.py b/lib/kaskara/post_install.py
@@ -0,0 +1,16 @@
+# -*- coding: utf-8 -*-
+"""
+This module is used to install Kaskara's various language backends following
+the installation of the Kaskara Python package via setuptools/pip.
+"""
+__all__ = ('post_install',)
+
+from loguru import logger
+
+from .clang import post_install as post_install_clang
+
+
+def post_install() -> None:
+    logger.info('performing post-installation of Kaskara')
+    post_install_clang()
+    logger.info('completed post-installation of Kaskara')
diff --git a/python/kaskara/project.py → lib/kaskara/project.py b/python/kaskara/project.py → lib/kaskara/project.py
@@ -12,7 +12,8 @@
 
 from .container import ProjectContainer
 
-KASKARA_IMAGE = 'squareslab/kaskara'
+# FIXME the plugin container shouldn't be launched from here
+KASKARA_IMAGE = 'christimperley/kaskara:cpp'
 
 
 @attr.s(frozen=True, slots=True, auto_attribs=True)

diff --git a/python/kaskara/python/__init__.py → lib/kaskara/python/__init__.py b/python/kaskara/python/__init__.py → lib/kaskara/python/__init__.py
diff --git a/python/kaskara/python/analyser.py → lib/kaskara/python/analyser.py b/python/kaskara/python/analyser.py → lib/kaskara/python/analyser.py
diff --git a/python/kaskara/python/analysis.py → lib/kaskara/python/analysis.py b/python/kaskara/python/analysis.py → lib/kaskara/python/analysis.py
diff --git a/python/kaskara/python/functions.py → lib/kaskara/python/functions.py b/python/kaskara/python/functions.py → lib/kaskara/python/functions.py
diff --git a/python/kaskara/python/loops.py → lib/kaskara/python/loops.py b/python/kaskara/python/loops.py → lib/kaskara/python/loops.py
diff --git a/python/kaskara/python/statements.py → lib/kaskara/python/statements.py b/python/kaskara/python/statements.py → lib/kaskara/python/statements.py
diff --git a/python/kaskara/python/util.py → lib/kaskara/python/util.py b/python/kaskara/python/util.py → lib/kaskara/python/util.py
diff --git a/python/kaskara/statements.py → lib/kaskara/statements.py b/python/kaskara/statements.py → lib/kaskara/statements.py
diff --git a/python/kaskara/util.py → lib/kaskara/util.py b/python/kaskara/util.py → lib/kaskara/util.py
diff --git a/python/kaskara/version.py → lib/kaskara/version.py b/python/kaskara/version.py → lib/kaskara/version.py
@@ -1,2 +1,2 @@
 # -*- coding: utf-8 -*-
-__version__ = '0.0.9'
+__version__ = '0.1.0'
diff --git a/setup.cfg b/setup.cfg
@@ -18,6 +18,7 @@ classifiers =
   Programming Language :: Python :: 3.8
 
 [options]
+include_package_data = True
 python_requires = >= 3.6
 install_requires =
   astor ~= 0.8.1
@@ -27,12 +28,13 @@ install_requires =
   loguru ~= 0.3.2
   requests ~= 2.22.0
   sourcelocation ~= 1.0.2
+  importlib_resources >= 1.0.2
 package_dir =
-  =python
+  =lib
 packages = find:
 
 [options.packages.find]
-where = python
+where = lib
 
 [aliases]
 test = pytest
@@ -57,8 +59,8 @@ commands =
   # NOTE nasty hack to prevent tox failing to install deps
   # https://github.com/tox-dev/tox/issues/149
   pip install {toxinidir}
-  mypy python
-  pycodestyle python
+  mypy lib
+  pycodestyle lib
   pytest
 
 [mypy]

diff --git a/setup.py b/setup.py
@@ -5,7 +5,7 @@
 from setuptools import setup, find_packages
 
 MODULE_FILE = \
-    os.path.join(os.path.dirname(__file__), 'python/kaskara/version.py')
+    os.path.join(os.path.dirname(__file__), 'lib/kaskara/version.py')
 VERSION_REGEX = \
     r"__version__\s+=\s+['|\"](.*)['|\"]\s*"