Use OFRAK_DIR for pytest_ofrak location in build_image.py (#657)

Co-authored-by: Jacob Strieb <[email protected]>

Author: whyitfor

build_image.py

@@ -258,6 +258,17 @@ def create_dockerfile_finish(config: OfrakImageConfig) -> str:
         f"FROM {full_base_image_name}:{config.image_revision}\n\n",
         f"ARG OFRAK_SRC_DIR=/\n",
     ]
+
+    # Extract OFRAK_DIR from extra_build_args if present
+    ofrak_dir_prefix = ""
+    if config.extra_build_args:
+        for i, arg in enumerate(config.extra_build_args):
+            if arg.startswith("OFRAK_DIR"):
+                ofrak_dir_prefix = arg.split("=", 1)[1]
+                if ofrak_dir_prefix and not ofrak_dir_prefix.endswith("/"):
+                    ofrak_dir_prefix += "/"
+                break
+
     package_names = list()
     for package_path in config.packages_paths:
         package_name = os.path.basename(package_path)
@@ -266,9 +277,11 @@ def create_dockerfile_finish(config: OfrakImageConfig) -> str:
     dockerfile_finish_parts.append("\nWORKDIR /\n")
     dockerfile_finish_parts.append("ARG INSTALL_TARGET\n")
     if config.install_target is InstallTarget.DEVELOP:
-        dockerfile_finish_parts.append("ADD requirements-dev.txt /\n")
+        dockerfile_finish_parts.append(f"ADD {ofrak_dir_prefix}requirements-dev.txt /\n")
         dockerfile_finish_parts.append("RUN python3 -m pip install -r requirements-dev.txt\n")
-        dockerfile_finish_parts.append(f"ADD 'pytest_ofrak' $OFRAK_SRC_DIR/pytest_ofrak\n")
+        dockerfile_finish_parts.append(
+            f"ADD '{ofrak_dir_prefix}pytest_ofrak' $OFRAK_SRC_DIR/pytest_ofrak\n"
+        )
         dockerfile_finish_parts.append(f"RUN make -C $OFRAK_SRC_DIR/pytest_ofrak develop\n")
     develop_makefile = "\\n\\\n".join(
         [

docs/README.md

@@ -25,10 +25,7 @@ Before building the docs, OFRAK, its dependencies, and the `ofrak-ghidra` packag
 ```
 python3 -m venv venv
 source venv/bin/activate
-for dir in ofrak_type ofrak_io ofrak_patch_maker ofrak_core disassemblers/ofrak_ghidra;
-do
-    make -C $dir develop;
-done
+make develop
 ```
 
 ## Build the Docs
@@ -52,3 +49,42 @@ OFRAK documentation comes from two sources: manually-written markdown files in `
 For writing docstrings that will display well, see the [contributor guidelines](https://ofrak.com/docs/contributor-guide/getting-started.html#docstrings). The list of packages whose docstrings are extracted can be found [in the script that does the extraction](https://github.com/redballoonsecurity/ofrak/blob/master/docs/gen_ref_nav.py#L69-L74).
 
 To add a markdown file to the docs, first write the documentation as a markdown file in the `docs/` directory of the repo. Then, add it to the documentation nav bar by [editing the `nav` property of `mkdocs.yml`](https://github.com/redballoonsecurity/ofrak/blob/master/mkdocs.yml#L50).
+
+### Decorative Footer Images
+
+**Each documentation page must have a decorative footer image at the end:**
+
+```html
+<div align="right">
+<img src="[PATH]/assets/square_[01-05].png" width="125" height="125">
+</div>
+```
+
+**Path calculation:**
+- Count directory levels from the file to `docs/` root
+- Use `../` for each level (e.g., `./assets/`, `../assets/`, `../../assets/`)
+
+**Image selection:**
+- Choose any number from 01-05 for visual variety
+
+**Examples:**
+```html
+<!-- docs/index.md -->
+<div align="right">
+<img src="./assets/square_02.png" width="125" height="125">
+</div>
+
+<!-- docs/install/docker.md -->
+<div align="right">
+<img src="../assets/square_03.png" width="125" height="125">
+</div>
+
+<!-- docs/user-guide/gui/settings.md -->
+<div align="right">
+<img src="../../assets/square_01.png" width="125" height="125">
+</div>
+```
+
+<div align="right">
+<img src="./assets/square_01.png" width="125" height="125">
+</div>

docs/contributor-guide/component/ghidra_components.md

@@ -90,3 +90,7 @@ If the script requires some arguments, they can also be passed to ``call_script`
 Often the OFRAK component needs to get some data back from the Ghidra script. This should be done by storing the data as a JSON string inside a [Ghidra headless variable](https://ghidra.re/ghidra_docs/api/ghidra/app/util/headless/HeadlessScript.html#storeHeadlessValue%28java.lang.String,java.lang.Object)
 at the end of the script.
 After running each script (e.g. `CustomScript`), the analysis server will get stored headless variable with the name `OfrakResult_<script name>` (e.g. `OfrakResult_CustomScript`) and send its data back to OFRAK. This data is then parsed as JSON and returned by the ``call_script`` method.
+
+<div align="right">
+<img src="../../assets/square_02.png" width="125" height="125">
+</div>

docs/gen_example_nav.py

@@ -33,7 +33,8 @@
 
     with mkdocs_gen_files.open(Path("examples", doc_path), "w") as f:
         # Build relative path to assets directory
-        animal_path = ("../" * len(module_path.parts)) / (
+        # Add 1 to account for the "examples" directory itself
+        animal_path = Path("../" * (len(module_path.parts) + 1)) / (
             animals[i % len(animals)].relative_to("docs")
         )
         print(

docs/index.md

@@ -74,3 +74,7 @@ Users interested in using OFRAK for commercial purposes can request the Pro or E
 
 ## Support
 Please contact [[email protected]](mailto:[email protected]), or write to us on [the OFRAK Slack](https://join.slack.com/t/ofrak/shared_invite/zt-1jku9h6r5-mY7CeeZ4AT8JVmu5YWw2Qg) with any questions or issues regarding OFRAK. We look forward to getting your feedback! Sign up for the [OFRAK Mailing List](https://ofrak.com/sign-up) to receive monthly updates about OFRAK code improvements and new features.
+
+<div align="right">
+<img src="./assets/square_02.png" width="125" height="125">
+</div>

docs/install/docker.md

@@ -201,3 +201,7 @@ Additionally:
 - **Permission issues**: Add `--user $(id -u):$(id -g)`
 - **Can't access GUI**: Check container is running with `docker ps`
 - **Out of memory**: Increase Docker memory limit
+
+<div align="right">
+<img src="../assets/square_03.png" width="125" height="125">
+</div>

docs/install/index.md

@@ -21,4 +21,8 @@
 
 ## Need Help Choosing?
 
-**Start with PyPI** if you're new to OFRAK. You can always switch methods later. 
+**Start with PyPI** if you're new to OFRAK. You can always switch methods later.
+
+<div align="right">
+<img src="../assets/square_04.png" width="125" height="125">
+</div> 

docs/install/pypi.md

@@ -84,3 +84,7 @@ python3.9 -m pip install ofrak
 ```bash
 pip install --user ofrak
 ```
+
+<div align="right">
+<img src="../assets/square_05.png" width="125" height="125">
+</div>

docs/install/source.md

@@ -125,3 +125,7 @@ make requirements-build-docker
 ## Next Steps
 
 - [Contributor Guide](../contributor-guide/getting-started.md) for development workflow
+
+<div align="right">
+<img src="../assets/square_01.png" width="125" height="125">
+</div>

docs/license.md

@@ -426,3 +426,7 @@ written and oral agreements and communications relating to the subject matter
 of this OFRAK Pro Agreement.  In the event of any conflict between this OFRAK
 Pro License Agreement and the OFRAK Community License Agreement, located at
 <https://ofrak.com/docs/license.html>, this OFRAK Pro Agreement shall control.
+
+<div align="right">
+<img src="./assets/square_03.png" width="125" height="125">
+</div>