Add dc_format input to the action

Signed-off-by: Andrei Horodniceanu <[email protected]>

Author: the-horo

.github/actions/verify-d-compiler/action.yml

@@ -16,6 +16,15 @@ inputs:
     description: "Use .sig file to verify downloaded archives"
     type: boolean
     default: true
+  dc_format:
+    description: "The way the $DC and $DMD variables are set: absolute path or basename"
+    default: absolute
+    required: true
+    type: choice
+    options:
+      - absolute
+      - basename
+      - shortname
 runs:
   using: "composite"
   steps:
@@ -26,6 +35,7 @@ runs:
         gh_token: ${{ inputs.gh_token }}
         gdmd_sha: ${{ inputs.gdmd_sha }}
         verify_sig: ${{ inputs.verify_sig }}
+        dc_format: ${{ inputs.dc_format }}
 
     - name: Verify D compiler ($DC)
       shell: bash

.github/workflows/test.yml

@@ -194,3 +194,75 @@ jobs:
       - name : Compile with dub
         run: |
           cd .github && dub run --single hello.d --compiler=${DC}
+
+  dc-format:
+    needs: verify-index-js-up-to-date
+    name: Check dc_format input
+    strategy:
+      max-parallel: 5
+      fail-fast: false
+      matrix:
+        include:
+          - { dc: dmd,        os: ubuntu-latest,  dc_format: absolute }
+          - { dc: ldc,        os: windows-latest, dc_format: absolute }
+          - { dc: gdc-14,     os: ubuntu-latest,  dc_format: shortname }
+          - { dc: ldc,        os: windows-latest, dc_format: basename }
+          - { dc: ldc-1.41.0, os: macos-latest,   dc_format: basename }
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ./.github/actions/verify-d-compiler
+        with:
+          dc: ${{ matrix.dc }}
+          dc_format: ${{ matrix.dc_format }}
+
+      - name: Check DC and DMD variables
+        run: |
+          fail=
+
+          for var in DC DMD; do
+              value="${!var}"
+
+              base=$(basename "${value}")
+              case "${DC_FORMAT}" in
+                  absolute)
+                      expected=$(command -v "${base}")
+                      if [[ ${{ matrix.os }} == windows-* ]]; then
+                          # expected == /c/hostedtoolcache/windows/ldc2/...
+
+                          drive=${expected:1:1} # c
+                          drive=${drive^} # C
+
+                          expected=${expected:2}
+                          # /hostedtoolcache/windows/ldc2/...
+                          expected=${expected//\//\\}
+                          # \hostedtoolcache\windows\ldc2\...
+                          expected=${drive}:${expected}
+                          # C:\hostedtoolcache\windows\ldc2\...
+                      fi
+                      ;;
+                  basename)
+                      expected="${base}"
+                      ;;
+                  shortname)
+                      expected="${base%.exe}"
+                      ;;
+                  *)
+                      echo "Unknown DC_FORMAT: ${DC_FORMAT}"
+                      exit 1
+                      ;;
+              esac
+
+              echo -n "Checking if ${var} (${value}) is ${expected}..."
+              if [[ ${value} == ${expected} ]]; then
+                  echo " good"
+              else
+                  echo " fail"
+                  fail=1
+              fi
+          done
+
+          [[ -z ${fail} ]] || exit 1
+        env:
+          DC_FORMAT: ${{ matrix.dc_format }}
+        shell: bash

README.md

@@ -105,6 +105,8 @@ Examples:
     gdmd_sha: '0a64b92ec5ad1177988496df4f3ca47c47580501'
     # turn off gpg verification (only dmd archives currently undergo this verification)
     verify_sig: false
+    # set DC to `gdc-12` and DMD to `gdmd-12` instead of `/usr/bin/gdc-12`
+    dc_format: basename
 ```
 
 ### compiler
@@ -169,6 +171,24 @@ The default value is `any`.
 You can disable installing an additional `dub` by passing an empty string.
 Note that this does not affect the `dub` executable that comes packaged with `dmd` and `ldc2`.
 
+### dc_format
+
+This option allows you to change the path value of the `DC` and `DMD` environment variables set by this action.
+There are three possible values:
+- `absolute`
+- `basename`
+- `shortname`
+
+Assuming that `ldc2` has been downloaded and extracted to the following directories, the `dc_format` input would set `$DC` like so:
+
+| | `C:\Program Files\ldc2-1.41.0-windows` | `/home/toolcache/cache/ldc2-1.41.0-linux` |
+| `absolute` | `C:\Program Files\ldc2-1.41.0-windows\bin\ldc2.exe` | `/home/toolcache/cache/ldc2-1.41.0-linux/bin/ldc2-1.40` |
+| `basename` | `ldc2.exe` | `ldc2-1.40` |
+| `shortname` | `ldc2` | `ldc2-1.40` |
+
+The default value for this setting is `absolute`.
+Previously, before `v2`, the action would set the variable in the same way `shortname` does now.
+
 ### gh_token
 
 A github token used to perform queries to https://api.github.com.
@@ -276,3 +296,9 @@ This is a special value that means:
 2. if the compiler is `gdc`, install latest `dub`
 
 This has become the default value because most D projects use `dub` to build and it is a hindrance to manually specify it just because `gdc` doesn't come with it.
+
+Added the `dc_format` input to control how the `DC` and `DMD` variables are set.
+They allow setting the variables to:
+- the absolute path of the compiler executable
+- the basename of the executable
+- the basename without the `.exe` extension

__tests__/d-compiler.test.ts

@@ -124,14 +124,58 @@ describe('Test Compiler class', () => {
         expect(process.env['DMD']).toBe(`${root}${bin}\\${dmdWrapper}.exe`)
     })
 
-    test('DC and DMD get set to the absolute path of the compiler', () => {
-	for (const platform of [ 'linux', 'win32', 'darwin', 'freebsd' ]) {
-        const sep = SETTINGS.sep = '/'
-        const exeExt = SETTINGS.exeExt = ''
-	    Object.defineProperty(process, 'platform', { value: platform })
-	    c.setDC(root)
-        expect(process.env['DC']).toBe(root + bin + sep + name + exeExt)
-        expect(process.env['DMD']).toBe(root + bin + sep + dmdWrapper + exeExt)
-	}
+    describe('Test DC and DMD path format', () => {
+        const origDcFormat = SETTINGS.dcFormat
+        beforeEach(() => SETTINGS.sep = '/')
+        afterEach(() => SETTINGS.dcFormat = origDcFormat)
+
+        test('default is absolute', () => {
+            SETTINGS.exeExt = '.exe'
+            c.setDC(root)
+            expect(process.env['DC']).toBe(root + bin + '/' + name + '.exe')
+            expect(process.env['DMD']).toBe(root + bin + '/' + dmdWrapper + '.exe')
+        })
+
+        test('explicit absolute', () => {
+            SETTINGS.exeExt = ''
+            SETTINGS.dcFormat = 'absolute'
+            c.setDC(root)
+            expect(process.env['DC']).toBe(root + bin + '/' + name)
+            expect(process.env['DMD']).toBe(root + bin + '/' + dmdWrapper)
+        })
+
+        describe('basename', () => {
+            beforeEach(() => SETTINGS.dcFormat = 'basename')
+            test('posix', () => {
+                SETTINGS.exeExt = ''
+                c.setDC(root)
+                expect(process.env['DC']).toBe(name)
+                expect(process.env['DMD']).toBe(dmdWrapper)
+            })
+
+            test('windows', () => {
+                SETTINGS.exeExt = '.exe'
+                c.setDC(root)
+                expect(process.env['DC']).toBe(name + '.exe')
+                expect(process.env['DMD']).toBe(dmdWrapper + '.exe')
+            })
+        })
+
+        describe('shortname', () => {
+            beforeEach(() => SETTINGS.dcFormat = 'shortname')
+            test('posix', () => {
+                SETTINGS.exeExt = ''
+                c.setDC(root)
+                expect(process.env['DC']).toBe(name)
+                expect(process.env['DMD']).toBe(dmdWrapper)
+            })
+
+            test('windows', () => {
+                SETTINGS.exeExt = '.exe'
+                c.setDC(root)
+                expect(process.env['DC']).toBe(name)
+                expect(process.env['DMD']).toBe(dmdWrapper)
+            })
+        })
     })
 })

__tests__/d-dmd.test.ts

@@ -535,4 +535,18 @@ describe('Test makeAvailable', () => {
             expect(gpgSpy).toHaveBeenCalled()
         })
     })
+
+    describe('test DC and DMD format', () => {
+        const origDcFormat = SETTINGS.dcFormat
+        afterEach(() => SETTINGS.dcFormat = origDcFormat)
+
+        test('basename', async () => {
+            SETTINGS.dcFormat = 'basename'
+            SETTINGS.exeExt = '.exe'
+            const dmd = await init('dmd-2.108')
+            await dmd.makeAvailable()
+            expect(process.env['DC']).toBe('dmd.exe')
+            expect(process.env['DMD']).toBe('dmd.exe')
+        })
+    })
 })

__tests__/d-gdc.test.ts

@@ -2,6 +2,9 @@ import { GDC } from '../src/d'
 import * as testUtils from './test-helpers.test'
 import * as exec from '@actions/exec'
 import * as tc from '@actions/tool-cache'
+import SETTINGS from '../src/settings'
+
+const GdmdSha = 'dc0ad9f739795f3ce5c69825efcd5d1d586bb013'
 
 testUtils.saveProcessRestorePoint()
 testUtils.hideConsoleLogs()
@@ -13,8 +16,7 @@ beforeEach(() => {
 })
 
 async function init (version: string) {
-    const gdmdSha = 'dc0ad9f739795f3ce5c69825efcd5d1d586bb013'
-    const gdc = await GDC.initialize(version, gdmdSha)
+    const gdc = await GDC.initialize(version, GdmdSha)
     await gdc.makeAvailableGdc()
 }
 
@@ -91,3 +93,15 @@ describe('Gdmd tests', () => {
     })
 })
 
+describe('test DC and DMD format', () => {
+    const origDcFormat = SETTINGS.dcFormat
+    afterEach(() => SETTINGS.dcFormat = origDcFormat)
+
+    test('shortname', async () => {
+        SETTINGS.dcFormat = 'shortname'
+        const gdc = await GDC.initialize('gdc-14', GdmdSha)
+        await gdc.makeAvailable()
+        expect(process.env['DC']).toBe('gdc-14')
+        expect(process.env['DMD']).toBe('gdmd-14')
+    })
+})

__tests__/d-ldc.test.ts

@@ -514,4 +514,17 @@ describe('Test makeAvailable', () => {
         expect(process.env['DC']).toBe(root + '\\ldc2-1.39.0-windows-multilib\\bin\\ldc2.exe')
         expect(process.env['DMD']).toBe(root + '\\ldc2-1.39.0-windows-multilib\\bin\\ldmd2.exe')
     })
+
+    describe('test DC and DMD format', () => {
+        const origDcFormat = SETTINGS.dcFormat
+        afterEach(() => SETTINGS.dcFormat = origDcFormat)
+
+        test('shortname', async () => {
+            SETTINGS.dcFormat = 'shortname'
+            const dmd = await init('ldc-1.39.0')
+            await dmd.makeAvailable()
+            expect(process.env['DC']).toBe('ldc2')
+            expect(process.env['DMD']).toBe('ldmd2')
+        })
+    })
 })

action.yml

@@ -9,6 +9,15 @@ inputs:
     description: "DUB version string, for example 'any', 'latest', or, '1.29.0'"
     default: any
     required: false
+  dc_format:
+    description: "The way the $DC and $DMD variables are set: absolute path or basename"
+    default: absolute
+    required: true
+    type: choice
+    options:
+      - absolute
+      - basename
+      - shortname
   gh_token:
     description: "Token to use when doing Github API request (for ldc-master)"
     default: ${{ github.token }}