Fix circular dependencies by making ofrak_angr and ofrak_capstone…

… optional for `ofrak_core` tests Fixes redballoonsecurity#420
ANogin · Jan 14, 2025 · ac02665 · ac02665
1 parent 829f1de
commit ac02665
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 52 deletions.
diff --git a/.github/workflows/test-all.yml b/.github/workflows/test-all.yml
@@ -50,8 +50,8 @@ jobs:
           cd frontend
           make check
 
-  ofrak-ghidra:
-    name: Test main OFRAK components
+  ofrak-dev:
+    name: Test all OFRAK components
     runs-on: ubuntu-22.04
     steps:
       - uses: actions/checkout@v3
@@ -62,11 +62,11 @@ jobs:
           python-version: '3.7'
           cache: pip
           cache-dependency-path: '**/setup.py'
-      - name: Build Ghidra image
+      - name: Build Dev image
         run: |
           python3 -m pip install PyYAML
           python3 build_image.py \
-            --config ofrak-ghidra.yml \
+            --config ofrak-dev.yml \
             --base \
             --finish \
             --cache-from redballoonsecurity/ofrak/core-dev-base:latest
@@ -77,7 +77,7 @@ jobs:
             --rm \
             --entrypoint bash \
             --volume "$(pwd)":/ofrak \
-            redballoonsecurity/ofrak/ghidra:latest \
+            redballoonsecurity/ofrak/dev:latest \
             -c "cd /ofrak \
                 && mkdocs build --site-dir /tmp/docs"
       - name: Test components
@@ -86,43 +86,11 @@ jobs:
             --interactive \
             --rm \
             --entrypoint bash \
-            redballoonsecurity/ofrak/ghidra:latest \
+            redballoonsecurity/ofrak/dev:latest \
             -c "python -m ofrak_ghidra.server start \
                 && ofrak license --community --i-agree \
                 && make test"
 
-  ofrak-angr:
-    name: Test OFRAK angr and capstone components
-    runs-on: ubuntu-22.04
-    steps:
-      - uses: actions/checkout@v3
-        with:
-          lfs: true
-      - uses: actions/setup-python@v4
-        with:
-          python-version: '3.7'
-          cache: pip
-          cache-dependency-path: '**/setup.py'
-      - name: Build angr image
-        run: |
-          python3 -m pip install PyYAML
-          python3 build_image.py \
-            --config ofrak-angr.yml \
-            --base \
-            --finish \
-            --cache-from redballoonsecurity/ofrak/core-dev-base:latest
-      - name: Test components
-        run: |
-          docker run \
-            --interactive \
-            --rm \
-            --entrypoint bash \
-            --volume "$(pwd)":/ofrak \
-            redballoonsecurity/ofrak/angr:latest \
-            -c "ofrak license --community --i-agree \
-              && make -C /ofrak_angr test \
-              && make -C /ofrak_capstone test"
-
   ofrak-tutorial:
     name: Test OFRAK examples and tutorial notebooks
     runs-on: ubuntu-22.04

diff --git a/ofrak_core/setup.py b/ofrak_core/setup.py
@@ -83,17 +83,7 @@ def read_requirements(requirements_path):
     + read_requirements("requirements.txt"),
     extras_require={
         "docs": read_requirements("requirements-docs.txt"),
-        "test": [
-            "importlib-resources",  # Needed because of https://github.com/redballoonsecurity/ofrak/issues/398
-            "ofrak_angr~=1.0",
-            # Running the tests requires this version of capstone.
-            #  If building a Docker image, it should already be installed on the system.
-            #  If you are running the tests in another environment, you will need to make sure
-            #  that this version is installed from GitHub, since it depends on ofrak==3.3.0rc0
-            #  and neither of these are yet released on PyPI.
-            # "ofrak_capstone>=1.1.0rc0",
-        ]
-        + read_requirements("requirements-test.txt"),
+        "test": read_requirements("requirements-test.txt"),
         "non-pypi": read_requirements("requirements-non-pypi.txt"),
     },
     author="Red Balloon Security",

diff --git a/ofrak_core/test_ofrak/components/test_patch_from_source.py b/ofrak_core/test_ofrak/components/test_patch_from_source.py
@@ -4,8 +4,8 @@
 
 from ofrak_patch_maker.toolchain.llvm_12 import LLVM_12_0_1_Toolchain
 
-import ofrak_angr
-import ofrak_capstone
+ofrak_angr = pytest.importorskip("ofrak_angr")
+ofrak_capstone = pytest.importorskip("ofrak_capstone")
 from ofrak import OFRAKContext, Resource, ResourceAttributeValueFilter, ResourceFilter
 from ofrak.core import (
     Allocatable,

diff --git a/ofrak_core/test_ofrak/components/test_symbolic_analysis.py b/ofrak_core/test_ofrak/components/test_symbolic_analysis.py
@@ -3,7 +3,7 @@
 
 import pytest
 
-import ofrak_angr
+ofrak_angr = pytest.importorskip("ofrak_angr")
 from ofrak import OFRAKContext, Resource, ResourceFilter
 from ofrak.core import (
     ElfSymbolType,