cicd.yml

#                    GNU LESSER GENERAL PUBLIC LICENSE
#                        Version 3, 29 June 2007
#
#  Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
#  Everyone is permitted to copy and distribute verbatim copies
#  of this license document, but changing it is not allowed.
#
#
#   This version of the GNU Lesser General Public License incorporates
# the terms and conditions of version 3 of the GNU General Public
# License, supplemented by the additional permissions listed below.
#
#   0. Additional Definitions.
#
#   As used herein, "this License" refers to version 3 of the GNU Lesser
# General Public License, and the "GNU GPL" refers to version 3 of the GNU
# General Public License.
#
#   "The Library" refers to a covered work governed by this License,
# other than an Application or a Combined Work as defined below.
#
#   An "Application" is any work that makes use of an interface provided
# by the Library, but which is not otherwise based on the Library.
# Defining a subclass of a class defined by the Library is deemed a mode
# of using an interface provided by the Library.
#
#   A "Combined Work" is a work produced by combining or linking an
# Application with the Library.  The particular version of the Library
# with which the Combined Work was made is also called the "Linked
# Version".
#
#   The "Minimal Corresponding Source" for a Combined Work means the
# Corresponding Source for the Combined Work, excluding any source code
# for portions of the Combined Work that, considered in isolation, are
# based on the Application, and not on the Linked Version.
#
#   The "Corresponding Application Code" for a Combined Work means the
# object code and/or source code for the Application, including any data
# and utility programs needed for reproducing the Combined Work from the
# Application, but excluding the System Libraries of the Combined Work.
#
#   1. Exception to Section 3 of the GNU GPL.
#
#   You may convey a covered work under sections 3 and 4 of this License
# without being bound by section 3 of the GNU GPL.
#
#   2. Conveying Modified Versions.
#
#   If you modify a copy of the Library, and, in your modifications, a
# facility refers to a function or data to be supplied by an Application
# that uses the facility (other than as an argument passed when the
# facility is invoked), then you may convey a copy of the modified
# version:
#
#    a) under this License, provided that you make a good faith effort to
#    ensure that, in the event an Application does not supply the
#    function or data, the facility still operates, and performs
#    whatever part of its purpose remains meaningful, or
#
#    b) under the GNU GPL, with none of the additional permissions of
#    this License applicable to that copy.
#
#   3. Object Code Incorporating Material from Library Header Files.
#
#   The object code form of an Application may incorporate material from
# a header file that is part of the Library.  You may convey such object
# code under terms of your choice, provided that, if the incorporated
# material is not limited to numerical parameters, data structure
# layouts and accessors, or small macros, inline functions and templates
# (ten or fewer lines in length), you do both of the following:
#
#    a) Give prominent notice with each copy of the object code that the
#    Library is used in it and that the Library and its use are
#    covered by this License.
#
#    b) Accompany the object code with a copy of the GNU GPL and this license
#    document.
#
#   4. Combined Works.
#
#   You may convey a Combined Work under terms of your choice that,
# taken together, effectively do not restrict modification of the
# portions of the Library contained in the Combined Work and reverse
# engineering for debugging such modifications, if you also do each of
# the following:
#
#    a) Give prominent notice with each copy of the Combined Work that
#    the Library is used in it and that the Library and its use are
#    covered by this License.
#
#    b) Accompany the Combined Work with a copy of the GNU GPL and this license
#    document.
#
#    c) For a Combined Work that displays copyright notices during
#    execution, include the copyright notice for the Library among
#    these notices, as well as a reference directing the user to the
#    copies of the GNU GPL and this license document.
#
#    d) Do one of the following:
#
#        0) Convey the Minimal Corresponding Source under the terms of this
#        License, and the Corresponding Application Code in a form
#        suitable for, and under terms that permit, the user to
#        recombine or relink the Application with a modified version of
#        the Linked Version to produce a modified Combined Work, in the
#        manner specified by section 6 of the GNU GPL for conveying
#        Corresponding Source.
#
#        1) Use a suitable shared library mechanism for linking with the
#        Library.  A suitable mechanism is one that (a) uses at run time
#        a copy of the Library already present on the user's computer
#        system, and (b) will operate properly with a modified version
#        of the Library that is interface-compatible with the Linked
#        Version.
#
#    e) Provide Installation Information, but only if you would otherwise
#    be required to provide such information under section 6 of the
#    GNU GPL, and only to the extent that such information is
#    necessary to install and execute a modified version of the
#    Combined Work produced by recombining or relinking the
#    Application with a modified version of the Linked Version. (If
#    you use option 4d0, the Installation Information must accompany
#    the Minimal Corresponding Source and Corresponding Application
#    Code. If you use option 4d1, you must provide the Installation
#    Information in the manner specified by section 6 of the GNU GPL
#    for conveying Corresponding Source.)
#
#   5. Combined Libraries.
#
#   You may place library facilities that are a work based on the
# Library side by side in a single library together with other library
# facilities that are not Applications and are not covered by this
# License, and convey such a combined library under terms of your
# choice, if you do both of the following:
#
#    a) Accompany the combined library with a copy of the same work based
#    on the Library, uncombined with any other library facilities,
#    conveyed under the terms of this License.
#
#    b) Give prominent notice with the combined library that part of it
#    is a work based on the Library, and explaining where to find the
#    accompanying uncombined form of the same work.
#
#   6. Revised Versions of the GNU Lesser General Public License.
#
#   The Free Software Foundation may publish revised and/or new versions
# of the GNU Lesser General Public License from time to time. Such new
# versions will be similar in spirit to the present version, but may
# differ in detail to address new problems or concerns.
#
#   Each version is given a distinguishing version number. If the
# Library as you received it specifies that a certain numbered version
# of the GNU Lesser General Public License "or any later version"
# applies to it, you have the option of following the terms and
# conditions either of that published version or of any later version
# published by the Free Software Foundation. If the Library as you
# received it does not specify a version number of the GNU Lesser
# General Public License, you may choose any version of the GNU Lesser
# General Public License ever published by the Free Software Foundation.
#
#   If the Library as you received it specifies that a proxy can decide
# whether future versions of the GNU Lesser General Public License shall
# apply, that proxy's public statement of acceptance of any version is
# permanent authorization for you to choose that version for the
# Library.

name: Rust CI

on:
  push:
    branches:
      - master
  pull_request:
    branches:
      - master

jobs:
  build:
    strategy:
      fail-fast: false
      matrix:
        os: [ubuntu-latest, macos-latest, macos-13, windows-latest]
        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]

    runs-on: ${{ matrix.os }}

    steps:
      - name: Checkout Code
        uses: actions/checkout@v3

      - name: Set up Rust
        uses: actions-rs/toolchain@v1
        with:
          toolchain: stable
          override: true

      - name: Set up Python
        uses: actions/setup-python@v4
        with:
          python-version: ${{ matrix.python-version }}

      - name: Install Dependencies (Ubuntu)
        if: ${{ matrix.os == 'ubuntu-latest' }}
        run: |
          sudo apt-get update
          sudo apt-get install -y build-essential pkg-config libssl-dev make

      - name: Install Dependencies (macOS)
        if: startsWith(matrix.os, 'macos-')
        run: |
          brew update
          brew install openssl

      - name: Enable Developer Command Prompt (Windows)
        if: ${{ matrix.os == 'windows-latest' }}
        uses: ilammy/msvc-dev-cmd@v1.7.0

      - name: Install Python Build Tools
        run: |
          python -m pip install --upgrade pip
          python -m pip install setuptools wheel virtualenv

      - name: Run Unit Tests
        run: cargo test

      - name: Build Project (Ubuntu)
        if: ${{ matrix.os == 'ubuntu-latest' }}
        run: make deb

      - name: Build Project (macOS)
        if: startsWith(matrix.os, 'macos-')
        run: cargo build --release

      - name: Build Project (Windows)
        if: ${{ matrix.os == 'windows-latest' }}
        run: cargo build --release

      - name: Build Python Wheels (Ubuntu)
        if: ${{ matrix.os == 'ubuntu-latest' }}
        run: |
          python -m venv venv
          . venv/bin/activate
          cd src/bindings/python/
          pip install maturin[patchelf]
          maturin build --release

      - name: Build Python Wheels (MacOS)
        if: startsWith(matrix.os, 'macos-')
        run: |
          python -m venv venv
          . venv/bin/activate
          cd src/bindings/python/
          pip install maturin
          maturin build --release

      - name: Build Python Wheels (Windows)
        if: ${{ matrix.os == 'windows-latest' }}
        run: |
          python -m venv venv
          .\venv\Scripts\activate
          cd src/bindings/python/
          pip install maturin
          maturin build --release

      - name: Create Dist Directory
        run: mkdir dist

      - name: Copy Binary (Windows)
        if: ${{ matrix.os == 'windows-latest' }}
        run: |
          copy target\release\binlex.exe dist\
          copy target\release\blyara.exe dist\
          copy target\release\blpdb.exe dist\
          copy target\release\blelfsym.exe dist\
          copy target\release\blmachosym.exe dist\
          copy target\release\blrizin.exe dist\
          copy target\release\blimage.exe dist\
          copy target\release\blhash.exe dist\
          copy target\release\blscaler.exe dist\
          copy target\wheels\*.whl dist\

      - name: Copy Binary (macOS)
        if: startsWith(matrix.os, 'macos-')
        run: |
          cp target/release/binlex dist/
          cp target/release/blyara dist/
          cp target/release/blpdb dist/
          cp target/release/blelfsym dist/
          cp target/release/blmachosym dist/
          cp target/release/blrizin dist/
          cp target/release/blimage dist/
          cp target/release/blhash dist/
          cp target/release/blscaler dist/
          cp target/wheels/*.whl dist/

      - name: Copy Binary (Ubuntu)
        if: ${{ matrix.os == 'ubuntu-latest' }}
        run: |
          cp target/release/binlex dist/
          cp target/release/blyara dist/
          cp target/release/blpdb dist/
          cp target/release/blelfsym dist/
          cp target/release/blmachosym dist/
          cp target/release/blrizin dist/
          cp target/release/blimage dist/
          cp target/release/blhash dist/
          cp target/release/blscaler dist/
          cp target/debian/*.deb dist/
          cp target/wheels/*.whl dist/

      - name: Upload Artifacts
        uses: actions/upload-artifact@v3
        with:
          name: ${{ matrix.os }}-artifacts
          path: dist/

  archlinux:
    runs-on: ubuntu-latest
    container:
      image: archlinux:latest
    steps:
      - name: Install Arch Dependencies
        run: |
          pacman -Syu --noconfirm
          pacman -S --noconfirm base-devel curl git
          echo '%wheel ALL=(ALL) NOPASSWD: ALL' >> /etc/sudoers
          useradd -m -G wheel builder
          echo 'builder ALL=(ALL) NOPASSWD: /usr/bin/make' >> /etc/sudoers

      - name: Setup Rust
        run: |
          sudo -u builder bash -c 'curl --proto "=https" --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y'
          sudo -u builder bash -c 'echo "export PATH=\\"$PATH:/home/builder/.cargo/bin\\"" >> /home/builder/.bashrc'
          sudo -u builder bash -c 'echo "source /home/builder/.cargo/env" >> /home/builder/.bashrc'

      - name: Checkout Code to Builder Home
        run: |
          sudo -u builder mkdir -p /home/builder/repo
          sudo -u builder bash -c "git clone https://github.com/${GITHUB_REPOSITORY}.git /home/builder/repo"
        env:
          GITHUB_REPOSITORY: ${{ github.repository }}

      - name: Build Project (Arch Linux)
        run: |
          sudo -u builder bash -c 'cd /home/builder/repo/ && . /home/builder/.cargo/env && make zst'

      - name: Run Unit Tests
        run: |
          sudo -u builder bash -c 'cd /home/builder/repo/ && . /home/builder/.cargo/env && cargo test'

      - name: Copy Binary (Arch Linux)
        run: |
          mkdir dist
          cp /home/builder/repo/target/release/binlex dist/
          cp /home/builder/repo/target/release/blyara dist/
          cp /home/builder/repo/target/release/blpdb dist/
          cp /home/builder/repo/target/release/blelfsym dist/
          cp /home/builder/repo/target/release/blmachosym dist/
          cp /home/builder/repo/target/release/blrizin dist/
          cp /home/builder/repo/target/release/blimage dist/
          cp /home/builder/repo/target/release/blhash dist/
          cp /home/builder/repo/target/release/blscaler dist/
          cp /home/builder/repo/target/zst/*.zst dist/

      - name: Upload Artifacts
        uses: actions/upload-artifact@v3
        with:
          name: archlinux-artifacts
          path: dist/