Add basic Github CI for testing and releases (#2)

* Create Pickled Canary CI config for GitHub --------- Co-authored-by: tmonaghan-mitre <[email protected]>
mitre · Jan 1, 2024 · 748990f · 748990f
1 parent 629812a
commit 748990f
Show file tree

Hide file tree

Showing 3 changed files with 263 additions and 4 deletions.
diff --git a/.github/workflows/pc_ci.yml b/.github/workflows/pc_ci.yml
@@ -0,0 +1,195 @@
+# This CI builds, tests, and (optionally) creates a draft release of PC
+name: Pickled-Canary CI
+
+on: [workflow_dispatch, push, pull_request]
+
+permissions:
+  contents: read
+
+jobs:
+
+  # This builds the rust search components for x86 macs
+  build_rust_mac_x86_64:
+    runs-on: macos-latest
+    env:
+      RUST_VERSION: nightly-2023-09-01
+    steps:
+      - uses: actions/checkout@v3
+      - name: Install Rust Nightly
+        run: |
+          rustup toolchain install $RUST_VERSION --component rustfmt clippy
+          rustup default $RUST_VERSION
+      - name: Build
+        working-directory: search
+        run: cargo build --release --verbose
+      - name: Archive PC Rust
+        uses: actions/upload-artifact@v3
+        with:
+          name: pickled_canary_rust_tools_mac_x86_64
+          path: search/target/release/treesearchtool
+
+  # This builds and tests the rust search components for Linux and Windows
+  build_rust:
+    runs-on: ubuntu-latest
+    env:
+      RUST_VERSION: nightly-2023-09-01
+    steps:
+      - uses: actions/checkout@v3
+      - name: Install Rust Nightly
+        run: |
+          rustup toolchain install $RUST_VERSION --component rustfmt clippy
+          rustup default $RUST_VERSION
+          sudo apt-get install -yqq gcc-mingw-w64
+          rustup target add x86_64-pc-windows-gnu
+      - name: Format Rust
+        working-directory: search
+        run: cargo fmt --all -- --color=always --check
+      - name: Check Rust with Clippy
+        working-directory: search
+        run: cargo clippy --workspace -- -D warnings
+      - name: Build
+        working-directory: search
+        run: cargo build --release --verbose
+      - name: Build Windows
+        working-directory: search
+        run: cargo build --release --verbose --target x86_64-pc-windows-gnu
+      - name: Run tests
+        working-directory: search
+        run: cargo test --verbose
+      - name: Prepare PC Rust archive
+        working-directory: search
+        run: |
+          mkdir target/release/binaries
+          mv target/release/treesearchtool target/x86_64-pc-windows-gnu/release/treesearchtool.exe target/release/binaries
+      - name: Archive PC Rust
+        uses: actions/upload-artifact@v3
+        with:
+          name: pickled_canary_rust_tools
+          path: search/target/release/binaries/*
+
+  # This builds and tests the Ghidra plugin
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        include:
+        # - GHIDRA_VERSION: '9.2.2'
+        #   GHIDRA_BUILD_DATE: "20201229"
+        # - GHIDRA_VERSION: '9.2.4'
+        #   GHIDRA_BUILD_DATE: "20210427"
+        # - GHIDRA_VERSION: "10.0"
+        #   GHIDRA_BUILD_DATE: "20210621"
+        # - GHIDRA_VERSION: "10.0.1"
+        #   GHIDRA_BUILD_DATE: "20210708"
+        # - GHIDRA_VERSION: "10.0.2"
+        #   GHIDRA_BUILD_DATE: "20210804"
+        # - GHIDRA_VERSION: "10.0.3"
+        #   GHIDRA_BUILD_DATE: "20210908"
+        # - GHIDRA_VERSION: "10.1"
+        #   GHIDRA_BUILD_DATE: "20211210"
+        # - GHIDRA_VERSION: "10.1.1"
+        #   GHIDRA_BUILD_DATE: "20211221"
+        # - GHIDRA_VERSION: "10.1.2"
+        #   GHIDRA_BUILD_DATE: "20220125"
+        # - GHIDRA_VERSION: "10.1.3"
+        #   GHIDRA_BUILD_DATE: "20220421"
+        # - GHIDRA_VERSION: "10.1.4"
+        #   GHIDRA_BUILD_DATE: "20220519"
+        # - GHIDRA_VERSION: "10.1.5"
+        #   GHIDRA_BUILD_DATE: "20220726"
+        # - GHIDRA_VERSION: "10.2"
+        #   GHIDRA_BUILD_DATE: "20221101"
+        # - GHIDRA_VERSION: "10.2.1"
+        #   GHIDRA_BUILD_DATE: "20221110"
+        # - GHIDRA_VERSION: "10.2.2"
+        #   GHIDRA_BUILD_DATE: "20221115"
+        # - GHIDRA_VERSION: "10.2.3"
+        #   GHIDRA_BUILD_DATE: "20230208"
+        # - GHIDRA_VERSION: "10.3"
+        #   GHIDRA_BUILD_DATE: "20230510"
+        # - GHIDRA_VERSION: "10.3.1"
+        #   GHIDRA_BUILD_DATE: "20230614"
+        # - GHIDRA_VERSION: "10.3.2"
+        #   GHIDRA_BUILD_DATE: "20230711"
+          - GHIDRA_VERSION: "10.3.3"
+            GHIDRA_BUILD_DATE: "20230829"
+          - GHIDRA_VERSION: "10.4"
+            GHIDRA_BUILD_DATE: "20230928"
+    env:
+      GHIDRA_LABEL: ${{ matrix.GHIDRA_VERSION }}_${{ matrix.GHIDRA_BUILD_DATE }}
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Get latest Ghidra version
+      env:
+        GHIDRA_URL: https://github.com/NationalSecurityAgency/ghidra/releases/download/Ghidra_${{ matrix.GHIDRA_VERSION }}_build/ghidra_${{ matrix.GHIDRA_VERSION }}_PUBLIC_${{ matrix.GHIDRA_BUILD_DATE }}.zip
+      run: |
+        echo "trying ${{ matrix.GHIDRA_VERSION }} on ${{ matrix.GHIDRA_BUILD_DATE }}"
+        mkdir ../Ghidra && wget --no-check-certificate -O ghidra.zip $GHIDRA_URL && unzip ghidra.zip && rm ghidra.zip && mv ghidra* ../Ghidra
+    - name: Set up JDK 17
+      uses: actions/setup-java@v3
+      with:
+        java-version: '17'
+        distribution: 'temurin'
+    - name: Setup Gradle
+      uses: gradle/gradle-build-action@v2
+      with:
+        gradle-version: 8.5
+    - name: Execute Gradle build
+      env:
+        GHIDRA_INSTALL_DIR: ${{ github.workspace }}/../Ghidra/ghidra_${{ matrix.GHIDRA_VERSION }}_PUBLIC
+      run: |
+        gradle build
+        gradle
+    - name: Execute Gradle test and coverage
+      env:
+        GHIDRA_INSTALL_DIR: ${{ github.workspace }}/../Ghidra/ghidra_${{ matrix.GHIDRA_VERSION }}_PUBLIC
+      run: gradle test jacocoTestReport
+    - name: Archive PC Extension
+      uses: actions/upload-artifact@v3
+      with:
+        path: dist/*.zip
+    - name: Archive Coverage Report
+      uses: actions/upload-artifact@v3
+      with:
+        name: pickled_canary-${{ env.GHIDRA_LABEL }}_coverage_report
+        path: build/reports/jacoco/test/*
+
+  # Bundle up a draft release if the version is tagged
+  release:
+    permissions: write-all
+    runs-on: ubuntu-latest
+    needs: [build, build_rust, build_rust_mac_x86_64]
+    if: startsWith(github.ref, 'refs/tags/')
+    steps:
+      - uses: actions/checkout@v3
+      - name: Make ouptut directory
+        run: mkdir output_release
+      - name: Download Artifacts
+        uses: actions/download-artifact@v3
+        with:
+          path: output_release
+          merge-multiple: true
+      - name: Make zip
+        run: |
+          cd output_release
+          mkdir ../output_release_coverage
+          mv *_coverage_report ../output_release_coverage
+          mv pickled_canary_rust_tools_mac_x86_64/treesearchtool pickled_canary_rust_tools/treesearchtool_mac_x86_64
+          rmdir pickled_canary_rust_tools_mac_x86_64
+          mv artifact/* .
+          rmdir artifact
+          zip -r pickled_canary-${{ github.ref_name }}.zip *
+          ls -la
+          cp pickled_canary-${{ github.ref_name }}.zip ../
+          cd ../output_release_coverage
+          zip -r pickled_canary-coverage_reports-${{ github.ref_name }}.zip *
+          mv pickled_canary-coverage_reports-${{ github.ref_name }}.zip ../
+      - name: Create Release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: >-
+          gh release create --draft ${{ github.ref_name }}
+          "pickled_canary-${{ github.ref_name }}.zip"
+          "pickled_canary-coverage_reports-${{ github.ref_name }}.zip"
+          --title "Pickled Canary ${{ github.ref_name}}"
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,4 @@
+
 data
 os
 .antProperties.xml
@@ -9,4 +10,36 @@ bin
 /.gradle/
 /build/
 search/pickled_canary/pickled_canary_lib.cpython-38-x86_64-linux-gnu.so
-/dist
+/dist
+
+
+
+### Windows ###
+# Windows thumbnail cache files
+Thumbs.db
+Thumbs.db:encryptable
+ehthumbs.db
+ehthumbs_vista.db
+
+# Dump file
+*.stackdump
+
+# Folder config file
+[Dd]esktop.ini
+
+# Recycle Bin used on file shares
+$RECYCLE.BIN/
+
+
+### macOS ###
+# General
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+
+# Thumbnails
+._*
diff --git a/build.gradle b/build.gradle
@@ -28,7 +28,10 @@
 // Gradle should be invoked from the directory of the project to build.  Please see the
 // application.gradle.version property in <GHIDRA_INSTALL_DIR>/Ghidra/application.properties
 // for the correction version of Gradle to use for the Ghidra installation you specify.
-
+plugins {
+    id("java")
+    id("jacoco")
+}
 //----------------------START "DO NOT MODIFY" SECTION------------------------------
 def ghidraInstallDir
 
@@ -51,16 +54,44 @@ repositories {
 	// Declare dependency repositories here.  This is not needed if dependencies are manually 
 	// dropped into the lib/ directory.
 	// See https://docs.gradle.org/current/userguide/declaring_repositories.html for more info.
-	// Ex: mavenCentral()`
+	// Ex: mavenCentral()
+	mavenCentral()
+}
+
+test {
+	useJUnitPlatform()
+
+	maxHeapSize='1G'
 }
 
 dependencies {
 	// Any external dependencies added here will automatically be copied to the lib/ directory when
 	// this extension is built.
+	testImplementation 'org.junit.jupiter:junit-jupiter-api:5.0.3'
+	testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine:5.0.3'
+	testCompileOnly 'junit:junit:4.12' 
+	testRuntimeOnly 'org.junit.vintage:junit-vintage-engine:5.8.1'
+	testImplementation 'org.jacoco:org.jacoco.agent:0.8.9'
+    testImplementation 'org.jacoco:org.jacoco.ant:0.8.9'
+
 }
 
+jacoco {
+    toolVersion = "0.8.9"
+}
+
+jacocoTestReport {
+    reports {
+        html.required = true
+        xml.required = true
+        csv.required = true
+    }
+    dependsOn test // tests are required to run before generating the report
+}
+
+
 // Exclude additional files from the built extension
 // Ex: buildExtension.exclude '.idea/**'
 
 buildExtension.exclude 'search/**'
-buildExtension.exclude 'example_patterns/**'
+buildExtension.exclude 'example_patterns/**'