test: throw if no valid outDir (electron#22412)

codebytere · web-flow · commit 02cf5baa323e · 2020-02-27T19:32:09.000Z
diff --git a/docs/development/testing.md b/docs/development/testing.md
@@ -32,6 +32,12 @@ by coding style rules. `npm run lint-py` will check all Python, using
 
 ## Unit Tests
 
+If you are not using [build-tools](https://github.com/electron/build-tools),
+ensure that that name you have configured for your
+local build of Electron is one of `Testing`, `Release`, `Default`, `Debug`, or
+you have set `process.env.ELECTRON_OUT_DIR`. Without these set, Electron will fail
+to perform some pre-testing steps.
+
 To run all unit tests, run `npm run test`. The unit tests are an Electron
 app (surprise!) that can be found in the `spec` folder. Note that it has
 its own `package.json` and that its dependencies are therefore not defined
diff --git a/script/lib/utils.js b/script/lib/utils.js
@@ -27,6 +27,7 @@ function getElectronExec () {
 
 function getOutDir (options = {}) {
   const shouldLog = options.shouldLog || false
+  const presetDirs = ['Testing', 'Release', 'Default', 'Debug']
 
   if (options.outDir || process.env.ELECTRON_OUT_DIR) {
     const outDir = options.outDir || process.env.ELECTRON_OUT_DIR
@@ -41,14 +42,18 @@ function getOutDir (options = {}) {
     // Throw error if user passed/set nonexistent directory.
     throw new Error(`${outDir} directory not configured on your machine.`)
   } else {
-    for (const buildType of ['Testing', 'Release', 'Default', 'Debug']) {
+    for (const buildType of presetDirs) {
       const outPath = path.resolve(SRC_DIR, 'out', buildType)
       if (fs.existsSync(outPath)) {
         if (shouldLog) console.log(`OUT_DIR is: ${buildType}`)
         return buildType
       }
     }
   }
+
+  // If we got here, it means process.env.ELECTRON_OUT_DIR was not
+  // set and none of the preset options could be found in /out, so throw
+  throw new Error(`No valid out directory found; use one of ${presetDirs.join(',')} or set process.env.ELECTRON_OUT_DIR`)
 }
 
 function getAbsoluteElectronExec () {

Original file line number	Diff line number	Diff line change
`@@ -27,6 +27,7 @@ function getElectronExec () {`
`27`	`27`
`28`	`28`	`function getOutDir (options = {}) {`
`29`	`29`	`const shouldLog = options.shouldLog \|\| false`
	`30`	`+ const presetDirs = ['Testing', 'Release', 'Default', 'Debug']`
`30`	`31`
`31`	`32`	`if (options.outDir \|\| process.env.ELECTRON_OUT_DIR) {`
`32`	`33`	`const outDir = options.outDir \|\| process.env.ELECTRON_OUT_DIR`
`@@ -41,14 +42,18 @@ function getOutDir (options = {}) {`
`41`	`42`	`// Throw error if user passed/set nonexistent directory.`
`42`	`43`	throw new Error(`${outDir} directory not configured on your machine.`)
`43`	`44`	`} else {`
`44`		`- for (const buildType of ['Testing', 'Release', 'Default', 'Debug']) {`
	`45`	`+ for (const buildType of presetDirs) {`
`45`	`46`	`const outPath = path.resolve(SRC_DIR, 'out', buildType)`
`46`	`47`	`if (fs.existsSync(outPath)) {`
`47`	`48`	if (shouldLog) console.log(`OUT_DIR is: ${buildType}`)
`48`	`49`	`return buildType`
`49`	`50`	`}`
`50`	`51`	`}`
`51`	`52`	`}`
	`53`	`+`
	`54`	`+ // If we got here, it means process.env.ELECTRON_OUT_DIR was not`
	`55`	`+ // set and none of the preset options could be found in /out, so throw`
	`56`	+ throw new Error(`No valid out directory found; use one of ${presetDirs.join(',')} or set process.env.ELECTRON_OUT_DIR`)
`52`	`57`	`}`
`53`	`58`
`54`	`59`	`function getAbsoluteElectronExec () {`