Refactor solver-tests.yml to simplify secret management (#2709)

Author: odow

.github/workflows/solver-tests.yml

@@ -11,32 +11,28 @@ jobs:
     runs-on: ubuntu-latest
     env:
       PACKAGE: ${{ matrix.package }}
-      XPRESS_JL_SKIP_LIB_CHECK: "true"
-      # It's okay to share this secret with other packages because it is the public
-      # community-xpauth.xpr and not something confidential to JuMP-dev.
-      XPAUTH_XPR: ${{ secrets.XPAUTH_XPR }}
     strategy:
       fail-fast: false
       matrix:
         include:
           - package: 'JuMP'
           - package: 'Convex'
           - package: 'AmplNLWriter'
-          # - package: 'BARON'  # Requires license
+          - package: 'BARON'
           - package: 'Cbc'
           - package: 'Clp'
-          # - package: 'CPLEX'  # See below
+          - package: 'CPLEX'
           - package: 'CSDP'  
           - package: 'DiffOpt'
           - package: 'DSDP'
           - package: 'Dualization'
           - package: 'ECOS'
           - package: 'GLPK'
-          # - package: 'Gurobi'  # See below
+          - package: 'Gurobi'
           - package: 'HiGHS'
           - package: 'Hypatia'
           - package: 'Ipopt'
-          # - package: 'KNITRO'  # See below
+          - package: 'KNITRO'
           - package: 'MiniZinc'
           - package: 'MosekTools'
           - package: 'MultiObjectiveAlgorithms'
@@ -49,7 +45,7 @@ jobs:
           - package: 'PolyJuMP'
           - package: 'SCS'
           - package: 'SDPA'
-          # - package: 'SDPLR'   # Requires MATLAB
+          - package: 'SDPLR'
           # - package: 'SDPNAL'  # Requires MATLAB
           # - package: 'SDPT3'   # Requires MATLAB
           # - package: 'SeduMi'  # Requires MATLAB
@@ -96,84 +92,78 @@ jobs:
           version: '1'
       - uses: julia-actions/cache@v2
       - uses: julia-actions/julia-buildpkg@v1
-      - name: Test
-        shell: julia --color=yes {0}
+      # Setup BARON.jl
+      - name: Add BARON secrets
+        if: ${{ matrix.package == 'BARON' }}
+        shell: bash
+        # Writing a multiline string is hard. GitHub says:
+        # https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/workflow-commands-for-github-actions#multiline-strings
+        #
+        # For multiline strings, you may use a delimiter with the following syntax.
+        #
+        #   {name}<<{delimiter}
+        #   {value}
+        #   {delimiter}
+        #
+        # Their example goes on to use 'EOF' as the delimiter, which works so
+        # long as 'EOF' does not appear in the string. If you get the error:
+        #
+        #   Run echo "SECRET_BARON_LICENSE='***
+        #   Error: Unable to process file command 'env' successfully.
+        #   Error: Invalid format '***'
+        #
+        # This is the most likely culprit.
         run: |
-          import Pkg
-          Pkg.develop(Pkg.PackageSpec(; path = pwd()))
-          if ENV["PACKAGE"] == "Xpress"
-            write("/opt/xpauth.xpr", ENV["XPAUTH_XPR"])
-            ENV["XPAUTH_PATH"] = "/opt/xpauth.xpr"
-            ENV["XPRESS_JL_SKIP_LIB_CHECK"] = true
-          end      
-          Pkg.develop(ENV["PACKAGE"])
-          Pkg.build(ENV["PACKAGE"])
-          Pkg.test(ENV["PACKAGE"])
-  test-cplex:
-    name: CPLEX
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - uses: julia-actions/setup-julia@v2
-        with:
-          version: '1'
-      - uses: julia-actions/cache@v2
-      - uses: julia-actions/julia-buildpkg@v1
-      - name: Test
-        shell: julia --color=yes {0}
-        env:
-          CPLEX_VERSION: '2210'
-          SECRET_CPLEX_URL_2210: ${{ secrets.SECRET_CPLEX_URL_2210 }}
+          {
+            echo "SECRET_BARON_LICENSE<<EOF"
+            echo "${{ secrets.BARON_LICENSE }}"
+            echo "EOF"
+          } >> $GITHUB_ENV
+      # Setup CPLEX.jl
+      - name: Add CPLEX secrets
+        if: ${{ matrix.package == 'CPLEX' }}
+        env: 
+          SECRET_CPLEX_URL_2210: ${{ secrets.CPLEX_URL_2210 }}
+        shell: bash
         run: |
-          import Pkg
-          Pkg.develop(Pkg.PackageSpec(; path = pwd()))
-          Pkg.develop("CPLEX")
-          Pkg.test("CPLEX")
-  test-gurobi:
-    name: Gurobi
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - uses: julia-actions/setup-julia@v2
-        with:
-          version: '1'
-      - uses: julia-actions/cache@v2
-      - shell: bash
-        env:
-          WLSLICENSE: ${{ secrets.WLSLICENSE }}
+          echo "SECRET_CPLEX_URL_2210=${SECRET_CPLEX_URL_2210}" >> $GITHUB_ENV
+          echo "CPLEX_VERSION=2210" >> $GITHUB_ENV
+      # Setup Gurobi.jl
+      - name: Add Gurobi secrets
+        if: ${{ matrix.package == 'Gurobi' }}
+        env: 
+          SECRET_GUROBI_LICENSE: ${{ secrets.GUROBI_LICENSE }}
+        shell: bash
         run: |
           mkdir -p /opt/gurobi
-          echo "$WLSLICENSE" > /opt/gurobi/gurobi.lic
-      - uses: julia-actions/julia-buildpkg@v1
-      - name: Test
-        shell: julia --color=yes {0}
+          echo "${SECRET_GUROBI_LICENSE}" > /opt/gurobi/gurobi.lic
+      # Setup KNITRO.jl
+      - name: Add KNITRO secrets
+        if: ${{ matrix.package == 'KNITRO' }}
+        env:
+          SECRET_KNITRO_LICENSE: ${{ secrets.KNITRO_LICENSE }}
+          SECRET_KNITRO_URL: ${{ secrets.KNITRO_URL }}
+          SECRET_KNITRO_LIBIOMP5: ${{ secrets.KNITRO_LIBIOMP5 }}
+        shell: bash
         run: |
-          import Pkg
-          Pkg.develop(Pkg.PackageSpec(; path = pwd()))
-          Pkg.develop("Gurobi")
-          Pkg.test("Gurobi")
-  test-knitro:
-    name: KNITRO
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - uses: julia-actions/setup-julia@v2
-        with:
-          version: '1'
-      - uses: julia-actions/cache@v2
-      - shell: bash
+          echo "${SECRET_KNITRO_LICENSE}" > ~/artelys_lic.txt
+          echo "SECRET_KNITRO_URL=${SECRET_KNITRO_URL}" >> $GITHUB_ENV
+          echo "SECRET_KNITRO_LIBIOMP5=${SECRET_KNITRO_LIBIOMP5}" >> $GITHUB_ENV
+      # Setup Xpress.jl
+      - name: Add Xpress secrets
+        if: ${{ matrix.package == 'Xpress' }}
         env:
-          ARTELYS_LIC_JUMP_DEV: ${{ secrets.ARTELYS_LIC_8326_JUMP_DEV_2023_11_02 }}
+          SECRET_XPRESS_LICENSE: ${{ secrets.XPRESS_LICENSE }}
+        shell: bash
         run: |
-          echo "$ARTELYS_LIC_JUMP_DEV" > ~/artelys_lic.txt
-      - name: Test
+          echo "${SECRET_XPRESS_LICENSE}" > /opt/xpauth.xpr
+          echo "XPRESS_JL_SKIP_LIB_CHECK=true" >> $GITHUB_ENV
+          echo "XPAUTH_PATH=/opt/xpauth.xpr" >> $GITHUB_ENV
+      - name: Run tests
         shell: julia --color=yes {0}
-        env:
-          SECRET_KNITRO_URL: ${{ secrets.SECRET_KNITRO_URL }}
-          SECRET_KNITRO_LIBIOMP5: ${{ secrets.SECRET_KNITRO_LIBIOMP5 }}
         run: |
           import Pkg
           Pkg.develop(Pkg.PackageSpec(; path = pwd()))
-          Pkg.develop("KNITRO")
-          Pkg.build("KNITRO")
-          Pkg.test("KNITRO")
+          Pkg.develop(ENV["PACKAGE"])
+          Pkg.build(ENV["PACKAGE"])
+          Pkg.test(ENV["PACKAGE"])