.gitlab-ci.yml

# Copyright 2019 ETH Zurich and University of Bologna
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.



before_script:
  - pwd

# after_script:
#   - echo "stage finished"

stages:
  - fetch
  - build
  - test

fetch_tests:
  stage: fetch
  script:
    - echo "Fetching tests"
    - make test-checkout-gitlab
  artifacts:
    name: "$CI_JOB_NAME-$CI_COMMIT_REF_NAME-$CI_COMMIT_SHORT_SHA"
    paths:
      - tests/*

fetch_ips:
  stage: fetch
  script:
    - echo "Fetching IPs"
    - make checkout
    - echo "Fetching VIPs"
    - ./rtl/vip/get-vips.sh --yes --gitlab
    - echo "Generate scripts with DPI and VIP support"
    - ./generate-scripts --rt-dpi --i2c-vip --flash-vip --i2s-vip

  artifacts:
    name: "$CI_JOB_NAME-$CI_COMMIT_REF_NAME-$CI_COMMIT_SHORT_SHA"
    paths:
      - ips/*
      - sim/*
      - ipstools/*
      - rtl/vip/*
      - .cached_ipdb.json

# This jobs result is too large to produce an artifact
# fetch_sdk:
#   stage: fetch
#   script:
#     - echo "Fetching SDK from releases and setting up paths"
#     - make sdk-gitlab
#   artifacts:
#     paths:
#       - pkg/
#       - env/

build_rtl:
  stage: build
  before_script:
  script:
    - echo "Compiling RTL model and DPI libraries"
    - make build
    - echo "Installing scripts"
    - make install
  artifacts:
    name: "$CI_JOB_NAME-$CI_COMMIT_REF_NAME-$CI_COMMIT_SHORT_SHA"
    paths:
      - tests/*
      - ips/*
      - sim/*
      - ipstools/*
#      - install/* # we have to rebuild in test stage because rtl libraries are
                   # not relocatable (hardcoded paths)
      - rtl/tb/remote_bitbang/* # we want to reuse bitbang lib
#      - pkg/* # sdk is too large

# Use sdk-releases to run all tests
test_sequential_bare:
  stage: test
  before_script:
    - echo "Fetching SDK from releases and setting up paths"
    - make sdk-gitlab
    - echo "Compiling RTL model and DPI libraries"
    - make build
    - echo "Installing scripts"
    - make install
  script:
    - echo "Running sequential bare tests"
    - source env/ci-pulpissimo.sh && make test-sequential-bare
    - echo "Generating junit test results"
    - /usr/sepp/bin/pip3.4 install --user junit2html
    - /usr/sepp/bin/python3.4 -m junit2htmlreport tests/sequential_bare_tests/junit-reports/TEST-*.xml
  artifacts:
    name: "$CI_JOB_NAME-$CI_COMMIT_REF_NAME-$CI_COMMIT_SHORT_SHA"
    paths:
      - tests/sequential_bare_tests/junit-reports/TEST-*.html
      - tests/sequential_bare_tests/junit-reports/TEST-*.xml
    reports:
      junit: tests/sequential_bare_tests/junit-reports/TEST-*.xml

# test_parallel_bare:
#   stage: test
#   before_script:
#     - echo "Fetching SDK from releases and setting up paths"
#     - make sdk-gitlab
#     - echo "Compiling RTL model and DPI libraries"
#     - make build
#     - echo "Installing scripts"
#     - make install
#   script:
#     - echo "Running parallel bare tests"
#     - source env/ci-pulpissimo.sh && make test-parallel-bare
#     - echo "Generating junit test results"
#     - /usr/sepp/bin/pip3.4 install --user junit2html
#     - /usr/sepp/bin/python3.4 -m junit2htmlreport tests/parallel_bare_tests/junit-reports/TEST-*.xml
#   artifacts:
#     name: "$CI_JOB_NAME-$CI_COMMIT_REF_NAME-$CI_COMMIT_SHORT_SHA"
#     paths:
#       - tests/parallel_bare_tests/junit-reports/TEST-*.html
#       - tests/parallel_bare_tests/junit-reports/TEST-*.xml
#     reports:
#       junit: tests/parallel_bare_tests/junit-reports/TEST-*.xml

test_pulp:
  stage: test
  before_script:
    - echo "Fetching SDK from releases and setting up paths"
    - make sdk-gitlab
    - echo "Compiling RTL model and DPI libraries"
    - make build
    - echo "Installing scripts"
    - make install
  script:
    - echo "Running pulp tests"
    - source env/ci-pulpissimo.sh && make test-pulp
    - echo "Generating junit test results"
    - /usr/sepp/bin/pip3.4 install --user junit2html
    - /usr/sepp/bin/python3.4 -m junit2htmlreport tests/pulp_tests/junit-reports/TEST-*.xml
  artifacts:
    name: "$CI_JOB_NAME-$CI_COMMIT_REF_NAME-$CI_COMMIT_SHORT_SHA"
    paths:
      - tests/pulp_tests/junit-reports/TEST-*.html
      - tests/pulp_tests/junit-reports/TEST-*.xml
    reports:
      junit: tests/pulp_tests/junit-reports/TEST-*.xml

test_ml:
  stage: test
  before_script:
    - echo "Fetching SDK from releases and setting up paths"
    - make sdk-gitlab
    - echo "Compiling RTL model and DPI libraries"
    - make build
    - echo "Installing scripts"
    - make install
  script:
    - echo "Running ml tests"
    - source env/ci-pulpissimo.sh && make test-ml
    - echo "Generating junit test results"
    - /usr/sepp/bin/pip3.4 install --user junit2html
    - /usr/sepp/bin/python3.4 -m junit2htmlreport tests/ml_tests/junit-reports/TEST-*.xml
  artifacts:
    name: "$CI_JOB_NAME-$CI_COMMIT_REF_NAME-$CI_COMMIT_SHORT_SHA"
    paths:
      - tests/ml_tests/junit-reports/TEST-*.html
      - tests/ml_tests/junit-reports/TEST-*.xml
    reports:
      junit: tests/ml_tests/junit-reports/TEST-*.xml

test_riscv:
  stage: test
  before_script:
    - echo "Fetching SDK from releases and setting up paths"
    - make sdk-gitlab
    - echo "Compiling RTL model and DPI libraries"
    - make build
    - echo "Installing scripts"
    - make install
  script:
    - echo "Running riscv tests"
    - source env/ci-pulpissimo.sh && make test-riscv
    - echo "Generating junit test results"
    - /usr/sepp/bin/pip3.4 install --user junit2html
    - /usr/sepp/bin/python3.4 -m junit2htmlreport tests/riscv_tests/junit-reports/TEST-*.xml
  artifacts:
    name: "$CI_JOB_NAME-$CI_COMMIT_REF_NAME-$CI_COMMIT_SHORT_SHA"
    paths:
      - tests/riscv_tests/junit-reports/TEST-*.html
      - tests/riscv_tests/junit-reports/TEST-*.xml
    reports:
      junit: tests/riscv_tests/junit-reports/TEST-*.xml

test_rt:
  stage: test
  before_script:
    - echo "Fetching SDK from releases and setting up paths"
    - make sdk-gitlab
    - echo "Compiling RTL model and DPI libraries"
    - make build
    - echo "Installing scripts"
    - make install
  script:
    - echo "Running rt tests"
    - source env/ci-pulpissimo.sh && make test-rt
    - echo "Generating junit test results"
    - /usr/sepp/bin/pip3.4 install --user junit2html
    - /usr/sepp/bin/python3.4 -m junit2htmlreport tests/rt-tests/junit-reports/TEST-*.xml
  artifacts:
    name: "$CI_JOB_NAME-$CI_COMMIT_REF_NAME-$CI_COMMIT_SHORT_SHA"
    paths:
      - tests/rt-tests/junit-reports/TEST-*.html
      - tests/rt-tests/junit-reports/TEST-*.xml
    reports:
      junit: tests/rt-tests/junit-reports/TEST-*.xml

# Use simplified pulp-runtime to run a subset of tests
# test_simplified_sw:
#   stage: test
#   before_script:
#     - echo "Fetching Runtime"
#     - make pulp-runtime
#     - echo "Compiling RTL model and DPI libraries"
#     - make build
#     - echo "Installing scripts"
#     - make install
#   script:
#     - echo "Running software test"
#     - source pulp-runtime/configs/pulpissimo.sh && make test-runtime-gitlab
#     - echo "Generating junit test results"
#     - /usr/sepp/bin/pip3.4 install --user junit2html
#     - /usr/sepp/bin/python3.4 -m junit2htmlreport tests/rt-tests/junit-reports/TEST-*.xml
#   artifacts:
#     name: "$CI_JOB_NAME-$CI_COMMIT_REF_NAME-$CI_COMMIT_SHORT_SHA"
#     paths:
#       - tests/*.html
#       - tests/*.xml
#     reports:
#       junit: tests/*.xml

# Built SDK with the `make sdk` target and run all tests
# test_sw_build_sdk:
#   variables:
#     PULP_RISCV_GCC_TOOLCHAIN: your-compiler-path
#   stage: test
#   before_script:
#     - echo "Compiling RTL model and DPI libraries"
#     - make build
#     - echo "Installing scripts" # don't call this, breaks build
#     - make install
#     - echo "Building SDK"
#     - make sdk
#   script:
#     - echo "Running software tests with built SDK"
#     - make test-gitlab2
#     - echo "Generating junit test results"
#     - /usr/sepp/bin/pip3.4 install --user junit2html
#     - /usr/sepp/bin/python3.4 -m junit2htmlreport tests/junit-reports/TEST-*.xml
#   artifacts:
#     paths:
#       - tests/junit-reports/TEST-*.html
#       - tests/junit-reports/TEST-*.xml
#     reports:
#       junit: tests/junit-reports/TEST-*.xml

test_dm:
  stage: test
  before_script:
  script:
    - echo "(Re)generating scripts with DPI disabled"
    - ./generate-scripts
    - echo "Setting up vsim path"
    - source setup/vsim.sh
    - echo "Running debug module testbench"
    - cd sim/ && make lib build opt simc VSIM_FLAGS=-gENABLE_DM_TESTS=1

fpga_synth_genesys2:
  stage: test
  before_script:
  script:
    - echo "(Re)generating scripts" # because paths might have changed
    - ./generate-scripts
    - echo "Starting synthesis with vivado"
    - cd fpga/ && make genesys2 VIVADO='vivado-2019.1.1 vivado'
  artifacts:
    name: "$CI_JOB_NAME-$CI_COMMIT_REF_NAME-$CI_COMMIT_SHORT_SHA"
    paths:
      - fpga/pulpissimo_genesys2.bit
      - fpga/pulpissimo_genesys2.bin
      - fpga/*.jou
      - fpga/*.log
      - fpga/*.str
      - fpga/pulpissimo-genesys2/reports
      - fpga/pulpissimo-genesys2/rtl
      - fpga/pulpissimo-genesys2/tcl
      - fpga/pulpissimo-genesys2/pulpissimo_genesys2.xpr
      - fpga/pulpissimo-genesys2/fpga-settings.mk
      - fpga/pulpissimo-genesys2/*.log
      - fpga/pulpissimo-genesys2/*.cfg
      - fpga/pulpissimo-genesys2/*.gdb
      - fpga/pulpissimo-genesys2/*.jou
      - fpga/pulpissimo-genesys2/*.log

fpga_synth_nexys_video:
  stage: test
  before_script:
  script:
    - echo "(Re)generating scripts" # because paths might have changed
    - ./generate-scripts
    - echo "Starting synthesis with vivado"
    - cd fpga/ && make nexys_video VIVADO='vivado-2019.1.1 vivado'
  artifacts:
    name: "$CI_JOB_NAME-$CI_COMMIT_REF_NAME-$CI_COMMIT_SHORT_SHA"
    paths:
      - fpga/pulpissimo_nexys_video.bit
      - fpga/pulpissimo_nexys_video.bin
      - fpga/*.jou
      - fpga/*.log
      - fpga/*.str
      - fpga/pulpissimo-nexys_video/reports
      - fpga/pulpissimo-nexys_video/rtl
      - fpga/pulpissimo-nexys_video/tcl
      - fpga/pulpissimo-nexys_video/pulpissimo_nexys_video.xpr
      - fpga/pulpissimo-nexys_video/fpga-settings.mk
      - fpga/pulpissimo-nexys_video/*.log
      - fpga/pulpissimo-nexys_video/*.cfg
      - fpga/pulpissimo-nexys_video/*.gdb
      - fpga/pulpissimo-nexys_video/*.jou
      - fpga/pulpissimo-nexys_video/*.log

fpga_synth_nexys:
  stage: test
  before_script:
  script:
    - echo "(Re)generating scripts" # because paths might have changed
    - ./generate-scripts
    - echo "Starting synthesis with vivado"
    - cd fpga/ && make nexys rev=nexys4 VIVADO='vivado-2019.1.1 vivado'
  artifacts:
    name: "$CI_JOB_NAME-$CI_COMMIT_REF_NAME-$CI_COMMIT_SHORT_SHA"
    paths:
      - fpga/pulpissimo_nexys.bit
      - fpga/pulpissimo_nexys.bin
      - fpga/*.jou
      - fpga/*.log
      - fpga/*.str
      - fpga/pulpissimo-nexys/reports
      - fpga/pulpissimo-nexys/rtl
      - fpga/pulpissimo-nexys/tcl
      - fpga/pulpissimo-nexys/pulpissimo_nexys.xpr
      - fpga/pulpissimo-nexys/fpga-settings.mk
      - fpga/pulpissimo-nexys/*.log
      - fpga/pulpissimo-nexys/*.cfg
      - fpga/pulpissimo-nexys/*.gdb
      - fpga/pulpissimo-nexys/*.jou
      - fpga/pulpissimo-nexys/*.log

fpga_synth_nexys_zcu104:
  stage: test
  before_script:
  script:
    - echo "(Re)generating scripts" # because paths might have changed
    - ./generate-scripts
    - echo "Starting synthesis with vivado"
    - cd fpga/ && make zcu104 VIVADO='vivado-2019.1.1 vivado'
  artifacts:
    name: "$CI_JOB_NAME-$CI_COMMIT_REF_NAME-$CI_COMMIT_SHORT_SHA"
    paths:
      - fpga/pulpissimo_zcu104.bit
      - fpga/pulpissimo_zcu104.bin
      - fpga/*.jou
      - fpga/*.log
      - fpga/*.str
      - fpga/pulpissimo-zcu104/reports
      - fpga/pulpissimo-zcu104/rtl
      - fpga/pulpissimo-zcu104/tcl
      - fpga/pulpissimo-zcu104/pulpissimo_zcu104.xpr
      - fpga/pulpissimo-zcu104/fpga-settings.mk
      - fpga/pulpissimo-zcu104/*.log
      - fpga/pulpissimo-zcu104/*.cfg
      - fpga/pulpissimo-zcu104/*.gdb
      - fpga/pulpissimo-zcu104/*.jou
      - fpga/pulpissimo-zcu104/*.log

fpga_synth_zedboard:
  stage: test
  before_script:
  script:
    - echo "(Re)generating scripts" # because paths might have changed
    - ./generate-scripts
    - echo "Starting synthesis with vivado"
    - cd fpga/ && make zedboard VIVADO='vivado-2019.1.1 vivado'
  artifacts:
    name: "$CI_JOB_NAME-$CI_COMMIT_REF_NAME-$CI_COMMIT_SHORT_SHA"
    paths:
      - fpga/pulpissimo_zedboard.bit
      - fpga/pulpissimo_zedboard.bin
      - fpga/*.jou
      - fpga/*.log
      - fpga/*.str
      - fpga/pulpissimo-zedboard/reports
      - fpga/pulpissimo-zedboard/rtl
      - fpga/pulpissimo-zedboard/tcl
      - fpga/pulpissimo-zedboard/pulpissimo_zedboard.xpr
      - fpga/pulpissimo-zedboard/fpga-settings.mk
      - fpga/pulpissimo-zedboard/*.log
      - fpga/pulpissimo-zedboard/*.cfg
      - fpga/pulpissimo-zedboard/*.gdb
      - fpga/pulpissimo-zedboard/*.jou
      - fpga/pulpissimo-zedboard/*.log

fpga_synth_zcu102:
  stage: test
  before_script:
  script:
    - echo "(Re)generating scripts" # because paths might have changed
    - ./generate-scripts
    - echo "Starting synthesis with vivado"
    - cd fpga/ && make zcu102 VIVADO='vivado-2019.1.1 vivado'
  artifacts:
    name: "$CI_JOB_NAME-$CI_COMMIT_REF_NAME-$CI_COMMIT_SHORT_SHA"
    paths:
      - fpga/pulpissimo_zcu102.bit
      - fpga/pulpissimo_zcu102.bin
      - fpga/*.jou
      - fpga/*.log
      - fpga/*.str
      - fpga/pulpissimo-zcu102/reports
      - fpga/pulpissimo-zcu102/rtl
      - fpga/pulpissimo-zcu102/tcl
      - fpga/pulpissimo-zcu102/pulpissimo_zcu102.xpr
      - fpga/pulpissimo-zcu102/fpga-settings.mk
      - fpga/pulpissimo-zcu102/*.log
      - fpga/pulpissimo-zcu102/*.cfg
      - fpga/pulpissimo-zcu102/*.gdb
      - fpga/pulpissimo-zcu102/*.jou
      - fpga/pulpissimo-zcu102/*.log