Merge: requirements -> development

Add requirements

.gitignore

@@ -168,3 +168,4 @@ res/out
 
 .vscode/
 .idea/
+.venv/

README.md

@@ -1,7 +1,7 @@
 # recompilation_postprocessor
 ![Pylint](https://github.com/VyacheslavIurevich/recompilation_postprocessor/actions/workflows/pylint.yml/badge.svg)
 
-This script provides ability to postprocess code, which is decompiled via Ghidra, to make it buildable.
+This script provides ability to postprocess code, which is decompiled via Ghidra, to make it recompilable.
 # Technologies used
 * [Python 3.12](https://www.python.org/)
 * [pyhidra](https://github.com/dod-cyber-crime-center/pyhidra)
@@ -22,18 +22,31 @@ or SSH:
 ```shell
 git clone [email protected]:VyacheslavIurevich/recompilation_postprocessor.git
 ```
-# Usage
+Set the GHIDRA_INSTALL_DIR environment variable to point to the directory where Ghidra is installed.
+```shell
+export GHIDRA_INSTALL_DIR={path to Ghidra}
+```
 Go to main folder of repository
 ```shell
 cd recompilation-postprocessor
 ```
+Create a virtual environment:
+```shell
+python3 -m venv .venv
+source .venv/bin/activate
+```
+Install requirements:
+```shell
+pip install -r requirements.txt
+```
+# Usage
 Run the script with input and output command line arguments.
 ```shell
-python run.py {path to input binary} {output .c file path}
+python3 run.py {path to input binary} {output .c file path}
 ```
 For example: 
 ```shell
-python run.py res/in/hello_world res/out/hello_world.c
+python3 run.py res/in/hello_world res/out/hello_world.c
 ```
 After this, you can try to compile output code. Example with GCC:
 ```shell

ci/pylint.sh

@@ -1,11 +1,3 @@
 #!/bin/bash
 echo "Running pylint"
 git ls-files '*.py' | xargs pylint
-pylint_check_status=$?
-if [[ $pylint_check_status -ne 0 ]]; then
-     echo "pylint fail"
-     exit 1
-else
-     echo "pylint OK"
-     exit 0
-fi

ci/shellcheck.sh

@@ -1,11 +1,3 @@
 #!/bin/bash
 echo "Running shellcheck"
 git ls-files '*.sh' | xargs shellcheck
-shellcheck_check_status=$?
-if [[ $shellcheck_check_status -ne 0 ]]; then
-     echo "shellcheck fail"
-     exit 1
-else
-     echo "shellcheck OK"
-     exit 0
-fi

ci/test.sh

@@ -1,12 +1,4 @@
 #!/bin/bash
 echo "Run tests"
-mkdir res/out
+mkdir -p res/out
 pytest src/tests/user_tests.py
-pytest_check_status=$?
-if [[ $pytest_check_status -ne 0 ]]; then
-     echo "Tests fail"
-     exit 1
-else
-     echo "Tests OK"
-     exit 0
-fi

requirements.txt

@@ -0,0 +1,3 @@
+pyhidra==1.2.0
+pytest==8.3.2
+pylint==3.2.6

src/scripts/dump.py

@@ -25,8 +25,8 @@ def put_program_data_types(program, file_writer, monitor, library_list):
     libc = {}
     typedefs = []
     with open(Application.getApplicationRootDirectory().getAbsolutePath()\
-        + "/Features/Base/data/parserprofiles/clib.prf", 'r', encoding="utf-8") as f:
-        for line in f:
+        + "/Features/Base/data/parserprofiles/clib.prf", 'r', encoding="utf-8") as file:
+        for line in file:
             if line == '\n':
                 break
             header = line.replace("\n", "")

src/tests/user_tests.py

@@ -24,25 +24,22 @@ def compile_binary(binary):
     return os.system(f"{COMPILER} {OUTPUT_PATH}")
 
 
-class TestUser:
-    """User scenario tests"""
+def test_hello_world(clean):
+    """Recompiles hello world binary"""
+    assert compile_binary("hello_world") == 0
 
-    def test_hello_world(self, clean):
-        """Recompiles hello world binary"""
-        assert compile_binary("hello_world") == 0
+def test_bmp(clean):
+    """Recompiles BMP header reader binary"""
+    assert compile_binary("bmp1") == 0
 
-    def test_bmp(self, clean):
-        """Recompiles BMP header reader binary"""
-        assert compile_binary("bmp1") == 0
+def test_bst(clean):
+    """Recompiles binary search tree binary"""
+    assert compile_binary("bst") == 0
 
-    def test_bst(self, clean):
-        """Recompiles binary search tree binary"""
-        assert compile_binary("bst") == 0
+def test_avl(clean):
+    """Recompiles AVL tree binary"""
+    assert compile_binary("avl") == 0
 
-    def test_avl(self, clean):
-        """Recompiles AVL tree binary"""
-        assert compile_binary("avl") == 0
-
-    def test_linpack(self, clean):
-        """Recompiles AVL tree binary"""
-        assert compile_binary("linpack") == 0
+def test_linpack(clean):
+    """Recompiles AVL tree binary"""
+    assert compile_binary("linpack") == 0