Reorganize path manipulation, mswin tools ENV

1. Use only one 'core' call to set PATH
2. Clean PATH
3. Windows mswin - add vcvars*.bat changes to ENV

index.js

@@ -1,5 +1,6 @@
 const os = require('os')
 const fs = require('fs')
+const path = require('path')
 const core = require('@actions/core')
 
 async function run() {
@@ -17,8 +18,12 @@ async function run() {
     const engineVersions = installer.getAvailableVersions(platform, engine)
     const ruby = validateRubyEngineAndVersion(platform, engineVersions, engine, version)
 
-    const rubyPrefix = await installer.install(platform, ruby)
-    core.setOutput('ruby-prefix', rubyPrefix)
+    // toolsPath is Windows build tools path additions
+    const [rubyPrefix, toolsPath] = await installer.install(platform, ruby)
+
+    await setupPath(rubyPrefix, ruby, toolsPath)
+
+    core.setOutput('ruby-prefix', rubyPrefix, toolsPath)
   } catch (error) {
     core.setFailed(error.message)
   }
@@ -102,4 +107,37 @@ function findUbuntuVersion() {
   }
 }
 
+function setupPath(rubyPrefix, ruby, toolsPath) {
+  // not used, saved for future
+  // const rubyPath = path.join(rubyPrefix, 'bin', 'ruby')
+  // const gemUserDir = cp.execSync(`${rubyPath} -e "puts Gem.user_dir"`).toString().trim()
+
+  const originalPath = process.env['PATH'].split(path.delimiter)
+
+  let cleanPath = originalPath.filter(e => !/\bruby\b/i.test(e))
+
+  if (cleanPath.length !== originalPath.length) {
+    console.log("Entries removed from PATH to avoid conflicts with Ruby:")
+    for (const entry of originalPath) {
+      if (!cleanPath.includes(entry)) {
+        console.log(`  ${entry}`)
+      }
+    }
+  }
+
+  let newPath = [path.join(rubyPrefix, 'bin')]
+
+  if (ruby.startsWith('rubinius')) {
+    newPath.push(path.join(rubyPrefix, 'gems', 'bin'))
+  }
+
+  if (toolsPath) { newPath.push(toolsPath) }
+
+  if (ruby.startsWith('rubinius')) {
+    newPath.push(path.join(rubyPrefix, 'gems', 'bin'))
+  }
+
+  core.exportVariable('PATH', [...newPath, ...cleanPath].join(path.delimiter))
+}
+
 run()

ruby-builder.js

@@ -1,6 +1,5 @@
 const os = require('os')
 const path = require('path')
-const core = require('@actions/core')
 const exec = require('@actions/exec')
 const io = require('@actions/io')
 const tc = require('@actions/tool-cache')
@@ -15,17 +14,7 @@ export function getAvailableVersions(platform, engine) {
 
 export async function install(platform, ruby) {
   const rubyPrefix = await downloadAndExtract(platform, ruby)
-
-  if (platform === 'windows-latest') {
-    require('./windows').setupPath(undefined, rubyPrefix)
-  } else {
-    core.addPath(path.join(rubyPrefix, 'bin'))
-    if (ruby.startsWith('rubinius')) {
-      core.addPath(path.join(rubyPrefix, 'gems', 'bin'))
-    }
-  }
-
-  return rubyPrefix
+  return [rubyPrefix, null]
 }
 
 async function downloadAndExtract(platform, ruby) {

windows.js

@@ -2,6 +2,7 @@
 // https://github.com/MSP-Greg/actions-ruby/blob/master/lib/main.js
 
 const fs = require('fs')
+const cp = require('child_process')
 const core = require('@actions/core')
 const exec = require('@actions/exec')
 const tc = require('@actions/tool-cache')
@@ -32,23 +33,44 @@ export async function install(platform, ruby) {
   await exec.exec('7z', ['x', downloadPath, `-xr!${base}\\share\\doc`, `-o${drive}:\\`], { silent: true })
   const rubyPrefix = `${drive}:\\${base}`
 
-  const [hostedRuby, msys2] = await linkMSYS2()
-  setupPath((ruby === 'ruby-mswin' ? null : msys2), rubyPrefix)
+  // we use certs and embedded MSYS2 from hostedRuby
+  const hostedRuby = latestHostedRuby()
 
-  if (version.startsWith('2.2') || version.startsWith('2.3')) {
-    core.exportVariable('SSL_CERT_FILE', `${hostedRuby}\\ssl\\cert.pem`)
-  } else if (version === 'mswin') {
-    setupMSWin(hostedRuby)
-  }
+  let toolsPath = (version === 'mswin') ?
+    await setupMSWin(hostedRuby) : await setupMingw(hostedRuby, version)
 
   if (!fs.existsSync(`${rubyPrefix}\\bin\\bundle.cmd`)) {
     await exec.exec(`${rubyPrefix}\\bin\\gem install bundler -v "~> 1" --no-document`)
   }
 
-  return rubyPrefix
+  return [rubyPrefix, toolsPath]
 }
 
-function setupMSWin(hostedRuby) {
+function latestHostedRuby() {
+  const toolCacheVersions = tc.findAllVersions('Ruby')
+  toolCacheVersions.sort()
+  if (toolCacheVersions.length === 0) {
+    throw new Error('Could not find MSYS2 in the toolcache')
+  }
+  const latestVersion = toolCacheVersions.slice(-1)[0]
+  return tc.find('Ruby', latestVersion)
+}
+
+async function setupMingw(hostedRuby, version) {
+  if (version.startsWith('2.2') || version.startsWith('2.3')) {
+    core.exportVariable('SSL_CERT_FILE', `${hostedRuby}\\ssl\\cert.pem`)
+  }
+
+  // Link to embedded MSYS2 in hostedRuby
+  const msys2 = 'C:\\msys64'
+  if (!fs.existsSync(msys2)) {
+    const hostedMSYS2 = `${hostedRuby}\\msys64`
+    await exec.exec(`cmd /c mklink /D ${msys2} ${hostedMSYS2}`)
+  }
+  return `${msys2}\\mingw64\\bin;${msys2}\\usr\\bin`
+}
+
+async function setupMSWin(hostedRuby) {
   // All standard MSVC OpenSSL builds use C:\Program Files\Common Files\SSL
   const certsDir = 'C:\\Program Files\\Common Files\\SSL\\certs'
   if (!fs.existsSync(certsDir)) {
@@ -61,51 +83,41 @@ function setupMSWin(hostedRuby) {
     const hostedCert = `${hostedRuby}\\ssl\\cert.pem`
     fs.copyFileSync(hostedCert, cert)
   }
-
-  // Add a convenience VCVARS environment variable to ease setting up MSVC
-  // This assumes a single Visual Studio version being available in the windows-latest image
-  core.exportVariable('VCVARS', '"C:\\Program Files (x86)\\Microsoft Visual Studio\\2019\\Enterprise\\VC\\Auxiliary\\Build\\vcvars64.bat"')
+  return addVCVARSEnv()
 }
 
-async function linkMSYS2() {
-  const toolCacheVersions = tc.findAllVersions('Ruby')
-  toolCacheVersions.sort()
-  if (toolCacheVersions.length === 0) {
-    throw new Error('Could not find MSYS2 in the toolcache')
-  }
-  const latestVersion = toolCacheVersions.slice(-1)[0]
-  const latestHostedRuby = tc.find('Ruby', latestVersion)
+/* Sets msvc environment for use in Actions
+ *   allows steps to run without running vcvars*.bat, also allows using PS scripts
+ *   adds a convenience VCVARS environment variable
+ *   this assumes a single Visual Studio version being available in the windows-latest image
+ */
+export function addVCVARSEnv() {
+  const vcVars = '"C:\\Program Files (x86)\\Microsoft Visual Studio\\2019\\Enterprise\\VC\\Auxiliary\\Build\\vcvars64.bat"'
+  core.exportVariable('VCVARS', vcVars)
 
-  const hostedMSYS2 = `${latestHostedRuby}\\msys64`
-  const msys2 = 'C:\\msys64'
-  if (!fs.existsSync(msys2)) {
-    await exec.exec(`cmd /c mklink /D ${msys2} ${hostedMSYS2}`)
-  }
-  return [latestHostedRuby, msys2]
-}
+  let newEnv = new Map()
 
-export function setupPath(msys2, rubyPrefix) {
-  const originalPath = process.env['PATH'].split(';')
-  let path = originalPath.slice()
+  let cmd = `cmd.exe /c "${vcVars} && set"`
 
-  // Remove default Ruby in PATH
-  path = path.filter(e => !e.match(/\bRuby\b/))
+  let newSet = cp.execSync(cmd).toString().trim().split(/\r?\n/)
 
-  if (msys2) {
-    // Add MSYS2 in PATH
-    path.unshift(`${msys2}\\mingw64\\bin`, `${msys2}\\usr\\bin`)
-  }
+  newSet = newSet.filter(line => line.match(/\S=\S/))
 
-  // Add the downloaded Ruby in PATH
-  path.unshift(`${rubyPrefix}\\bin`)
+  newSet.forEach(s => {
+    let [k,v] = s.split('=', 2)
+    newEnv.set(k,v)
+  })
 
-  console.log("Entries removed from PATH to avoid conflicts with Ruby:")
-  for (const entry of originalPath) {
-    if (!path.includes(entry)) {
-      console.log(entry)
+  let pathAdd
+
+  newEnv.forEach( (v, k, ) => {
+    if (process.env[k] !== v) {
+      if (k === 'Path') {
+        pathAdd = v.replace(process.env['Path'], '')
+      } else {
+        core.exportVariable(k, v)
+      }
     }
-  }
-
-  const newPath = path.join(';')
-  core.exportVariable('PATH', newPath)
+  })
+  return pathAdd
 }