tests_scripts.yml

# documentation: https://help.github.com/en/articles/workflow-syntax-for-github-actions
name: Tests for scripts
on:
  push:
    paths:
      - create_directory_tarballs.sh
      - create_lmodsitepackage.py
      - eessi_container.sh
      - EESSI-install-software.sh
      - install_software_layer.sh
      - load_easybuild_module.sh
      - run_in_compat_layer_env.sh
      - scripts/utils.sh
      - update_lmod_cache.sh

  pull_request:
    paths:
      - create_directory_tarballs.sh
      - create_lmodsitepackage.py
      - eessi_container.sh
      - EESSI-install-software.sh
      - install_software_layer.sh
      - load_easybuild_module.sh
      - run_in_compat_layer_env.sh
      - scripts/utils.sh
      - update_lmod_cache.sh
permissions:
  contents: read # to fetch code (actions/checkout)
jobs:
  build:
    runs-on: ubuntu-24.04
    strategy:
      fail-fast: false
      matrix:
        EESSI_VERSION:
          - '2023.06'
          - '2025.06'
    steps:
    - name: checkout
      uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1

    - name: install Apptainer
      run: |
        ./install_apptainer_ubuntu.sh

    - name: test load_easybuild_module.sh script
      run: |
        export SINGULARITY_CACHEDIR=$PWD
        # bind current directory into container as /software-layer-scripts
        export SINGULARITY_BIND="${PWD}:/software-layer-scripts"

        # can't test with EasyBuild versions older than v4.5.2 when using EESSI 2023.06,
        # since Python in compat layer is Python 3.11.x;
        # testing with a single EasyBuild version takes a while in GitHub Actions, so stick to a single sensible version
        for EB_VERSION in '5.1.0'; do
          # Create script that uses load_easybuild_module.sh which we can run in compat layer environment
          # note: Be careful with single vs double quotes below!
          #       ${EB_VERSION} should be expanded, so use double quotes;
          #       For statements using variables that are only defined in the script, like ${EASYBUILD_INSTALLPATH},
          #       use single quotes to avoid expansion while creating the script.
          test_script="${PWD}/eb-${EB_VERSION}.sh"
          echo '#!/bin/bash' > ${test_script}
          # both $EB and $TMPDIR environment must be set, required by load_easybuild_module.sh script
          echo 'export EB="eb"' >> ${test_script}
          echo 'export TMPDIR=$(mktemp -d)' >> ${test_script}
          # set up environment to have utility functions in place that load_easybuild_module.sh script relies on,
          # along with $EESSI_* environment variables, and Lmod
          echo 'ls -l /software-layer-scripts/' >> ${test_script}
          echo 'export EESSI_VERSION_OVERRIDE="${{matrix.EESSI_VERSION}}"' >> ${test_script}
          echo 'source /software-layer-scripts/scripts/utils.sh' >> ${test_script}
          echo 'source /software-layer-scripts/init/eessi_environment_variables' >> ${test_script}
          echo 'source ${EPREFIX}/usr/share/Lmod/init/bash' >> ${test_script}
          # minimal configuration for EasyBuild so we can test installation aspect of load_easybuild_module.sh script
          echo "export EASYBUILD_INSTALLPATH=/tmp/eb-${EB_VERSION}" >> ${test_script}
          echo 'module use ${EASYBUILD_INSTALLPATH}/modules/all' >> ${test_script}
          echo '' >> ${test_script}
          echo "source /software-layer-scripts/load_easybuild_module.sh ${EB_VERSION}" >> ${test_script}
          echo 'module list' >> ${test_script}
          echo 'eb --version' >> ${test_script}

          chmod u+x ${test_script}

          # make sure that correct EESSI version is used (required because default is a placeholder version)
          export EESSI_VERSION_OVERRIDE="${{matrix.EESSI_VERSION}}"

          # run wrapper script + capture & check output
          out="${PWD}/eb-${EB_VERSION}.out"
          ./eessi_container.sh --access rw --mode exec --verbose /software-layer-scripts/run_in_compat_layer_env.sh /software-layer-scripts/eb-${EB_VERSION}.sh 2>&1 | tee ${out}
          pattern="^This is EasyBuild ${EB_VERSION} "
          grep "${pattern}" ${out} || (echo "Pattern '${pattern}' not found in output!" && exit 1)
        done

    - name: test install_software_layer.sh script
      run: |
          export SINGULARITY_CACHEDIR=$PWD
          # bind current directory into container as /software-layer-scripts
          export SINGULARITY_BIND="${PWD}:/software-layer-scripts"
          # force using x86_64/generic, to avoid triggering an installation from scratch
          sed -i "s@./EESSI-install-software.sh@\"export EESSI_SOFTWARE_SUBDIR_OVERRIDE='x86_64/generic'; ./EESSI-install-software.sh\"@g" install_software_layer.sh
          # skip installation of CUDA SDKs, since this is too heavy for CI
          sed -i "s@./EESSI-install-software.sh@./EESSI-install-software.sh --skip-cuda-install@g" install_software_layer.sh

          # make sure that correct EESSI version is used (required because default is a placeholder version)
          export EESSI_VERSION_OVERRIDE="${{matrix.EESSI_VERSION}}"

          ./eessi_container.sh --mode exec --verbose /software-layer-scripts/install_software_layer.sh

    - name: test create_directory_tarballs.sh script
      run: |
          export SINGULARITY_CACHEDIR=$PWD
          # bind current directory into container as /software-layer-scripts
          export SINGULARITY_BIND="${PWD}:/software-layer-scripts"

          # make sure that correct EESSI version is used (required because default is a placeholder version)
          export EESSI_VERSION_OVERRIDE="${{matrix.EESSI_VERSION}}"

          # scripts need to be copied to /tmp,
          # since create_directory_tarballs.sh must be accessible from within build container
          ./eessi_container.sh --mode exec --verbose /software-layer-scripts/create_directory_tarballs.sh "${{matrix.EESSI_VERSION}}"
          # check if tarballs have been produced
          ls -l *.tar.gz

    - name: test create_lmodsitepackage.py script
      run: |
          export SINGULARITY_CACHEDIR=$PWD
          # bind current directory into container as /software-layer-scripts
          export SINGULARITY_BIND="${PWD}:/software-layer-scripts"

          # Creates .lmod/SitePackage.lua in current dir, which then gets bind-mounted into /software-layer-scripts
          python3 create_lmodsitepackage.py .
          # run some commands to make sure that generated Lmod SitePackage file works
          test_script="${PWD}/test_lmod_sitepackage.sh"
          echo '#!/bin/bash' > ${test_script}
          echo 'export LMOD_PACKAGE_PATH="/software-layer-scripts/.lmod"' > ${test_script}
          echo 'ml --config' >> ${test_script}

          chmod u+x ${test_script}

          # make sure that correct EESSI version is used (required because default is a placeholder version)
          export EESSI_VERSION_OVERRIDE="${{matrix.EESSI_VERSION}}"

          out="${PWD}/test_create_lmodsitepackage.out"
          ./eessi_container.sh --mode exec --verbose /software-layer-scripts/run_in_compat_layer_env.sh /software-layer-scripts/test_lmod_sitepackage.sh 2>&1 | tee ${out}
          for pattern in "^Site Pkg location.*/software-layer-scripts/.lmod/SitePackage.lua" "LMOD_SITEPACKAGE_LOCATION.*/software-layer-scripts/.lmod/SitePackage.lua"; do
            grep "${pattern}" ${out} || (echo "Pattern '${pattern}' not found in output!" && exit 1)
          done

    - name: Mount EESSI CernVM-FS repository
      uses: eessi/github-action-eessi@v3
      with:
        eessi_stack_version: ${{matrix.EESSI_VERSION}}
        use_eessi_module: true

    - name: Verify that mounted repositories are passed through directly
      run: |
          export SINGULARITY_CACHEDIR=$PWD
          # run wrapper script + capture & check output
          export SINGULARITY_BIND="${PWD}:/software-layer-scripts"
          # make sure that correct EESSI version is used (required because default is a placeholder version)
          export EESSI_VERSION_OVERRIDE="${{matrix.EESSI_VERSION}}"

          out="${PWD}/eb-${EB_VERSION}.out"
          ./eessi_container.sh --repository software.eessi.io,access=rw,mount=bind --mode exec --verbose /software-layer-scripts/run_in_compat_layer_env.sh ls 2>&1 | tee ${out}
          echo $(grep "SINGULARITY_BIND" ${out})
          grep "SINGULARITY_BIND" ${out} | grep "software.eessi.io" || (echo "software.eessi.io did not seem to be bind mounted!" && exit 1)