Assignment 2.1: Build Automation Tool

solutions/ankurdubey521/Build Automation Tool/.gitignore

@@ -0,0 +1,2 @@
+/venv/
+.idea

solutions/ankurdubey521/Build Automation Tool/Builder/lib/buildconfig.py

@@ -0,0 +1,75 @@
+import json
+
+
+class Command:
+    """Stores Command Information"""
+    def __init__(self, *, name, command_string, deps=None, files=None):
+        self._name = name
+        self._command_string = command_string
+        if files is None:
+            self._hasFiles = False
+        else:
+            self._hasFiles = True
+            self._files = files
+        if deps is None:
+            self._hasDependencies = False
+        else:
+            self._hasDependencies = True
+            self._dependencies = deps
+
+    def get_name(self):
+        return self._name
+
+    def get_files(self):
+        if self._hasFiles:
+            return self._files
+        raise Command.NoFilesException("No Files for {}".format(self._name))
+
+    def get_command_string(self):
+        return self._command_string
+
+    def get_dependencies(self):
+        if self._hasDependencies:
+            return self._dependencies
+        raise Command.NoDependenciesException("No Dependencies for {}".format(self._name))
+
+    class NoDependenciesException(Exception):
+        pass
+
+    class NoFilesException(Exception):
+        pass
+
+
+class BuildConfig:
+    """Parses and Stores build.config"""
+    def __init__(self, json_containing_folder):
+        # Parse JSON
+        json_path = json_containing_folder + "/build.json"
+        with open(json_path) as file_handle:
+            self._raw_json = json.load(file_handle)
+
+        self._name_to_command = {}
+        for command in self._raw_json:
+            self._name_to_command[command['name']] = command
+
+    def get_command(self, command_name):
+        if command_name in self._name_to_command:
+            entry = self._name_to_command[command_name]
+            name = entry['name']
+            command_string = entry['command']
+            deps = None
+            if 'deps' in entry:
+                deps = entry['deps']
+            files = None
+            if 'files' in entry:
+                files = entry['files']
+            return Command(name=name, command_string=command_string, deps=deps, files=files)
+        else:
+            raise BuildConfig.UnknownCommandException('No such command "{}" found.'.format(command_name))
+
+    class UnknownCommandException(Exception):
+        pass
+
+
+if __name__ == '__main__':
+    pass

solutions/ankurdubey521/Build Automation Tool/Builder/lib/commandrunner.py

@@ -0,0 +1,9 @@
+import subprocess
+
+
+def run(command_string, cwd, print_command=False):
+    """Run Command and Return Exit Code. Optionally Print the command itself"""
+    if print_command:
+        print(command_string)
+    return subprocess.run(command_string, shell=True, cwd=cwd).returncode
+

solutions/ankurdubey521/Build Automation Tool/Builder/main.py

@@ -0,0 +1,91 @@
+from Builder.lib.commandrunner import run
+from Builder.lib.buildconfig import BuildConfig, Command
+
+import sys
+import os
+
+
+class Builder:
+    def __init__(self):
+        self.unresolved_commands = set()
+
+    def _build_rule_handler(self, command_name, command_dir_abs, root_dir_abs, dry_run=False):
+        """Parses JSON, Resolves Dependencies and Executes Command/Do a dry run"""
+
+        # Remove Trailing '/' from paths if present
+        if command_dir_abs.endswith('/'):
+            command_dir_abs = command_dir_abs[:-1]
+        if root_dir_abs.endswith('/'):
+            root_dir_abs = root_dir_abs[:-1]
+
+        # Mark the command's dependencies as unresolved
+        self.unresolved_commands.add((command_name, command_dir_abs))
+
+        # Parse build.json in current directory
+        config = BuildConfig(command_dir_abs)
+        command = config.get_command(command_name)
+
+        # Process Dependencies
+        try:
+            deps = command.get_dependencies()
+            if not dry_run:
+                print("Executing {} dependencies for {} in {}...".format(len(deps), command_name, command_dir_abs))
+            for dep in deps:
+                dep_dir_abs = ''
+                dep_name = ''
+                if dep.startswith('//'):
+                    # Command path referenced from root directory
+                    dep_dir_abs = root_dir_abs + '/' + dep[2:]
+                    dep_dir_abs, dep_name = dep_dir_abs.rsplit('/', 1)
+                elif '/' in dep:
+                    # Command in child directory
+                    dep_dir_abs, dep_name = dep.rsplit('/', 1)
+                    dep_dir_abs = command_dir_abs + "/" + dep_dir_abs
+                else:
+                    # Command in same directory
+                    dep_name = dep
+                    dep_dir_abs = command_dir_abs
+
+                # Check for circular dependencies
+                if (dep_name, dep_dir_abs) in self.unresolved_commands:
+                    raise self.CircularDependencyException(
+                        "Detected a Circular Dependency between {}:{} and {}:{}"
+                        .format(dep_dir_abs, dep_name, command_dir_abs, command_name))
+
+                self._build_rule_handler(dep_name, dep_dir_abs, root_dir_abs, dry_run)
+
+        except Command.NoDependenciesException:
+            print("No dependencies found for {} in {}...".format(command_name, command_dir_abs))
+
+        # Mark the command's dependencies as resolved
+        self.unresolved_commands.remove((command_name, command_dir_abs))
+
+        if not dry_run:
+            # Execute Command after processing dependencies
+            print("Executing {} in {}".format(command_name, command_dir_abs))
+            return_value = run(command.get_command_string(), command_dir_abs, print_command=True)
+
+            # Stop Execution if Command Fails
+            if return_value != 0:
+                exit(-1)
+
+    def execute_build_rule(self, command_name, command_dir_abs, root_dir_abs):
+        # Do a dry run and check for syntax, do validation and check for circular dependencies
+        self._build_rule_handler(command_name, command_dir_abs, root_dir_abs, dry_run=True)
+
+        # If everything is fine do an actual run
+        self._build_rule_handler(command_name, command_dir_abs, root_dir_abs)
+
+    class CircularDependencyException(Exception):
+        pass
+
+
+if __name__ == '__main__':
+    command = sys.argv[1]
+    builder = Builder()
+    relative_path = ''
+    if '/' in command:
+        # Handle relative paths
+        relative_path, command = command.rsplit('/', 1)
+    path = os.getcwd() + "/" + relative_path
+    Builder.execute_build_rule(command, path, os.getcwd())

solutions/ankurdubey521/Build Automation Tool/Builder/tests/json/build.json

@@ -0,0 +1,12 @@
+[
+  {
+    "name": "clean",
+    "deps": ["algorithms/clean"],
+    "command": "rm -f test.o && rm -f test.exe"
+  },
+  {
+    "name": "test",
+    "files": ["test.cpp"],
+    "command": "g++ -std=c++11 -c test.cpp"
+  }
+]

solutions/ankurdubey521/Build Automation Tool/Builder/tests/test_buildconfig.py

@@ -0,0 +1,37 @@
+import unittest
+from Builder.lib.buildconfig import Command, BuildConfig
+
+
+class TestJsonParser(unittest.TestCase):
+
+    @classmethod
+    def setUpClass(cls):
+        json_path = 'json'
+        cls.config = BuildConfig(json_path)
+
+    def test_build_clean_parses_correctly(self):
+        command_clean = self.config.get_command('clean')
+        self.assertEqual(command_clean.get_name(), 'clean')
+        self.assertEqual(command_clean.get_command_string(), 'rm -f test.o && rm -f test.exe')
+        self.assertEqual(command_clean.get_dependencies(), ["algorithms/clean"])
+
+    def test_build_test_parses_correctly(self):
+        command_test = self.config.get_command('test')
+        self.assertEqual(command_test.get_name(), 'test')
+        self.assertEqual(command_test.get_command_string(), 'g++ -std=c++11 -c test.cpp')
+        self.assertEqual(command_test.get_files(), ["test.cpp"])
+
+    def test_no_deps_throws_correct_exception(self):
+        command_test = self.config.get_command('test')
+        self.assertRaises(Command.NoDependenciesException, command_test.get_dependencies)
+
+    def test_no_files_throws_correct_exception(self):
+        command_clean = self.config.get_command('clean')
+        self.assertRaises(Command.NoFilesException, command_clean.get_files)
+
+    def test_unknown_command_name_raises_correct_exception(self):
+        self.assertRaises(BuildConfig.UnknownCommandException, self.config.get_command, 'YOLO')
+
+
+if __name__ == '__main__':
+    unittest.main()

solutions/ankurdubey521/Build Automation Tool/Builder/tests/test_builder.py

@@ -0,0 +1,48 @@
+import unittest
+import subprocess
+import os
+from Builder.main import Builder
+
+
+class TestBuilder(unittest.TestCase):
+
+    def test_compilation_basic(self):
+        builder = Builder()
+        path = os.getcwd() + '/test_builder_files/test_compilation_basic'
+        builder.execute_build_rule('run', path, path)
+        exec_path = '"' + path + '/test.out' + '"'
+        result = subprocess.run(exec_path, shell=True, capture_output=True, text=True)
+        self.assertEqual('1 2 3 4 5 \n1 2 3 4 5 \n1 2 3 4 5 \n', result.stdout)
+        builder.execute_build_rule('clean', path, os.getcwd())
+
+    def test_commands_referenced_from_root(self):
+        builder = Builder()
+        path = os.getcwd() + '/test_builder_files/test_commands_referenced_from_root'
+        builder.execute_build_rule('run', path, path)
+        output_file_path = path + '/output'
+        result = ''
+        with open(output_file_path) as file_handle:
+            result = file_handle.readable()
+        builder.execute_build_rule('clean', path, os.getcwd() + '/test_builder_files/test_commands_referenced_from_root')
+        self.assertEqual(True, result)
+
+    def test_dry_run_does_not_write_files(self):
+        builder = Builder()
+        path = os.getcwd() + '/test_builder_files/test_commands_referenced_from_root'
+        builder._build_rule_handler('run', path, path, dry_run=True)
+        output_file_path = path + '/output'
+        self.assertEqual(False, os.path.isfile(output_file_path))
+
+    def test_basic_circular_dependency_throws_exception(self):
+        builder = Builder()
+        path = os.getcwd() + '/test_builder_files/test_basic_circular_dependency_throws_exception'
+        self.assertRaises(Builder.CircularDependencyException, builder.execute_build_rule, 'A', path, path)
+
+    def test_basic_circular_dependency2_throws_exception(self):
+        builder = Builder()
+        path = os.getcwd() + '/test_builder_files/test_basic_circular_dependency2_throws_exception'
+        self.assertRaises(Builder.CircularDependencyException, builder.execute_build_rule, 'A', path, path)
+
+
+if __name__ == '__main__':
+    unittest.main()

solutions/ankurdubey521/Build Automation Tool/Builder/tests/test_builder_files/test_basic_circular_dependency2_throws_exception/X/build.json

@@ -0,0 +1,7 @@
+[
+  {
+    "name": "A",
+    "command": "echo \"A\"",
+    "deps": ["//A"]
+  }
+] 

solutions/ankurdubey521/Build Automation Tool/Builder/tests/test_builder_files/test_basic_circular_dependency2_throws_exception/build.json

@@ -0,0 +1,7 @@
+[
+  {
+    "name": "A",
+    "command": "echo \"A\"",
+    "deps": ["X/A"]
+  }
+] 

solutions/ankurdubey521/Build Automation Tool/Builder/tests/test_builder_files/test_basic_circular_dependency_throws_exception/build.json

@@ -0,0 +1,12 @@
+[
+  {
+    "name": "A",
+    "command": "echo \"A\"",
+    "deps": ["B"]
+  },
+  {
+    "name": "B",
+    "command": "echo \"B\"",
+    "deps": ["A"]
+  }
+] 

solutions/ankurdubey521/Build Automation Tool/Builder/tests/test_builder_files/test_commands_referenced_from_root/A/build.json

@@ -0,0 +1,10 @@
+[
+  {
+    "name": "clean",
+    "command": "echo \"clean A\""
+  },
+  {
+    "name": "run",
+    "command": "echo \"run A\" >> ../output"
+  }
+] 

solutions/ankurdubey521/Build Automation Tool/Builder/tests/test_builder_files/test_commands_referenced_from_root/A/output

@@ -0,0 +1 @@
+run A

solutions/ankurdubey521/Build Automation Tool/Builder/tests/test_builder_files/test_commands_referenced_from_root/B/build.json

@@ -0,0 +1,11 @@
+[
+  {
+    "name": "clean",
+    "command": "echo \"clean B\""
+  },
+  {
+    "name": "run",
+    "deps": ["//A/run"],
+    "command": "echo \"run B\" >> ../output"
+  }
+] 

solutions/ankurdubey521/Build Automation Tool/Builder/tests/test_builder_files/test_commands_referenced_from_root/build.json

@@ -0,0 +1,11 @@
+[
+  {
+    "name": "clean",
+    "command": "rm output"
+  },
+  {
+    "name": "run",
+    "deps": ["B/run"],
+    "command": "echo \"run root\" >> output"
+  }
+] 

solutions/ankurdubey521/Build Automation Tool/Builder/tests/test_builder_files/test_compilation_basic/algorithms/build.json

@@ -0,0 +1,21 @@
+[
+  {
+    "name": "clean",
+    "command": "rm -f *.o"
+  },
+  {
+    "name": "sort_bubble",
+    "files": ["sort_bubble.cpp"],
+    "command": "g++ -c sort_bubble.cpp"
+  },
+  {
+    "name": "sort_merge",
+    "files": ["sort_merge.cpp"],
+    "command": "g++ -c sort_merge.cpp"
+  },
+  {
+    "name": "sort_quick",
+    "files": ["sort_quick.cpp"],
+    "command": "g++ -c sort_quick.cpp"
+  }
+]

solutions/ankurdubey521/Build Automation Tool/Builder/tests/test_builder_files/test_compilation_basic/algorithms/sort_bubble.cpp

@@ -0,0 +1,6 @@
+#include<vector>
+#include<algorithm>
+
+void sort_bubble(std::vector<int> &arr) {
+    sort(arr.begin(), arr.end());
+}

solutions/ankurdubey521/Build Automation Tool/Builder/tests/test_builder_files/test_compilation_basic/algorithms/sort_merge.cpp

@@ -0,0 +1,6 @@
+#include<vector>
+#include<algorithm>
+
+void sort_merge(std::vector<int> &arr) {
+    sort(arr.begin(), arr.end());
+}

solutions/ankurdubey521/Build Automation Tool/Builder/tests/test_builder_files/test_compilation_basic/algorithms/sort_quick.cpp

@@ -0,0 +1,6 @@
+#include<vector>
+#include<algorithm>
+
+void sort_quick(std::vector<int> &arr) {
+    sort(arr.begin(), arr.end());
+}