name: OpenFPGA Tests

# Run CI on
# - each push
# - each pull request
# - scheduled weekly
on:
  push:
  pull_request:
  schedule:
    - cron: '0 0 * * 0 ' # weekly

# Environment variables
env:
  # Customize the CMake build type here (Release, Debug, RelWithDebInfo, etc.)
  BUILD_TYPE: Release
  MAKEFLAGS: "-j8"

# Multiple job to tests
jobs:
  # Test the compilation compatibility
  build:
    name: ${{ matrix.config.name }}
    runs-on: ${{ matrix.config.os }}

    # Branch on different OS and settings
    strategy:
      fail-fast: false
      matrix:
        config:
        - {
            name: "Build Compatibility: GCC-5 (Ubuntu 18.04)",
            artifact: "OpenFPGA-ubuntu-18.04-gcc5-build.7z",
            os: ubuntu-18.04,
            cc: "gcc-5", cxx: "g++-5"
          }

        - {
            name: "Build Compatibility: GCC-6 (Ubuntu 18.04)",
            artifact: "OpenFPGA-ubuntu-18.04-gcc6-build.7z",
            os: ubuntu-18.04,
            cc: "gcc-6", cxx: "g++-6"
          }

        - {
            name: "Build Compatibility: GCC-7 (Ubuntu 18.04)",
            artifact: "OpenFPGA-ubuntu-18.04-gcc7-build.7z",
            os: ubuntu-18.04,
            cc: "gcc-7", cxx: "g++-7"
          }

        - {
            name: "Build Compatibility: GCC-8 (Ubuntu 18.04)",
            artifact: "OpenFPGA-ubuntu-18.04-gcc8-build.7z",
            os: ubuntu-18.04,
            cc: "gcc-8", cxx: "g++-8"
          }

        - {
            name: "Build Compatibility: GCC-9 (Ubuntu 18.04)",
            artifact: "OpenFPGA-ubuntu-18.04-gcc9-build.7z",
            os: ubuntu-18.04,
            cc: "gcc-9", cxx: "g++-9"
          }

        - {
            name: "Build Compatibility: Clang-6 (Ubuntu 18.04)",
            artifact: "OpenFPGA-ubuntu-18.04-clang6-build.7z",
            os: ubuntu-18.04,
            cc: "clang-6.0", cxx: "clang++-6.0"
          }

        - {
            name: "Build Compatibility: Clang-8 (Ubuntu 18.04)",
            artifact: "OpenFPGA-ubuntu-18.04-clang8-build.7z",
            os: ubuntu-18.04,
            cc: "clang-8", cxx: "clang++-8"
          }

        - {
            name: "Basic Regression Tests: GCC-8 (Ubuntu 18.04)",
            artifact: "OpenFPGA-basic-tests-ubuntu-18.04-gcc8-build.7z",
            os: ubuntu-18.04,
            cc: "gcc-8", cxx: "g++-8",
            reg_script: "basic_reg_test.sh"
          }

        - {
            name: "FPGA-Verilog Regression Tests: GCC-8 (Ubuntu 18.04)",
            artifact: "OpenFPGA-fpga-verilog-tests-ubuntu-18.04-gcc8-build.7z",
            os: ubuntu-18.04,
            cc: "gcc-8", cxx: "g++-8",
            reg_script: "fpga_verilog_reg_test.sh"
          }

        - {
            name: "FPGA-Bitstream Regression Tests: GCC-8 (Ubuntu 18.04)",
            artifact: "OpenFPGA-fpga-bitstream-tests-ubuntu-18.04-gcc8-build.7z",
            os: ubuntu-18.04,
            cc: "gcc-8", cxx: "g++-8",
            reg_script: "fpga_bitstream_reg_test.sh"
          }

        - {
            name: "FPGA-SDC Regression Tests: GCC-8 (Ubuntu 18.04)",
            artifact: "OpenFPGA-fpga-sdc-tests-ubuntu-18.04-gcc8-build.7z",
            os: ubuntu-18.04,
            cc: "gcc-8", cxx: "g++-8",
            reg_script: "fpga_sdc_reg_test.sh"
          }

        - {
            name: "FPGA-SPICE Regression Tests: GCC-8 (Ubuntu 18.04)",
            artifact: "OpenFPGA-fpga-spice-tests-ubuntu-18.04-gcc8-build.7z",
            os: ubuntu-18.04,
            cc: "gcc-8", cxx: "g++-8",
            reg_script: "fpga_spice_reg_test.sh"
          }


    # Define the steps to run the build job
    steps:
      - name: Checkout OpenFPGA repo
        uses: actions/checkout@v2

      - name: Install dependency
        run: source ./.github/workflows/install_dependency.sh 

      - name: Checkout CMake version
        run: cmake --version 

      - name: Checkout iVerilog version
        run: |
          iverilog -V 
          vvp -V 

      - name: Prepare ccache timestamp
        id: ccache_cache_timestamp
        shell: cmake -P {0}
        run: |
          string(TIMESTAMP current_date "%Y-%m-%d-%H;%M;%S" UTC)
          message("::set-output name=timestamp::${current_date}")

      - name: Create CMake build environment
        # Some projects don't allow in-source building, so create a separate build directory
        # We'll use this as our working directory for all subsequent commands
        run: cmake -E make_directory ${{runner.workspace}}/build
      
      - name: ccache cache files
        uses: actions/cache@v2
        with:
          path: $ENV{GITHUB_WORKSPACE}/.ccache
          key: ${{ matrix.config.name }}-ccache-${{ steps.ccache_cache_timestamp.outputs.timestamp }}
          restore-keys: |
            ${{ matrix.config.name }}-ccache-

      # Set up the paths for ccache and control the size under 400MB
      - name: Configure ccache
        shell: cmake -P {0}
        run: |
          file(TO_CMAKE_PATH "$ENV{GITHUB_WORKSPACE}" ccache_basedir)
          set(ENV{CCACHE_BASEDIR} "${ccache_basedir}")
          set(ENV{CCACHE_DIR} "${ccache_basedir}/.ccache")
          set(ENV{CCACHE_COMPRESS} "true")
          set(ENV{CCACHE_COMPRESSLEVEL} "6")
          set(ENV{CCACHE_MAXSIZE} "400M")

          execute_process(COMMAND ccache -p)
          execute_process(COMMAND ccache -z)

      - name: Configure CMake
        # Use a bash shell so we can use the same syntax for environment variable
        # access regardless of the host operating system
        shell: bash
        working-directory: ${{runner.workspace}}/build
        # Note the current convention is to use the -S and -B options here to specify source 
        # and build directories, but this is only available with CMake 3.13 and higher.  
        # The CMake binaries on the Github Actions machines are (as of this writing) 3.12
        run: |
          export CC=${{ matrix.config.cc }}
          export CXX=${{ matrix.config.cxx }}
          cmake $GITHUB_WORKSPACE -DCMAKE_BUILD_TYPE=$BUILD_TYPE -DCMAKE_C_COMPILER_LAUNCHER=ccache -DCMAKE_CXX_COMPILER_LAUNCHER=ccache

      - name: Build
        working-directory: ${{runner.workspace}}/build
        shell: bash
        # Execute the build.  You can specify a specific target with "--target <NAME>"
        run: |
          cmake --build . --config $BUILD_TYPE 

      # Check the cache size and see if it is over the limit
      - name: Check ccache size
        shell: cmake -P {0}
        run: |
          execute_process(COMMAND ccache -s)

      - name: ${{matrix.config.name}}
        if: contains(matrix.config.name, 'Regression Test')
        shell: bash
        # Execute the test. 
        run: source ./.github/workflows/${{matrix.config.reg_script}}