build(docs-infra): renamed e2e property of example-config.json to tests

gkalpak · gkalpak · commit 29ace22e6602 · 2020-04-06T23:03:04.000+03:00
Each docs example has an `example-config.json` configuration file. Among other things, this file can be used to specify what commands to run in order to test the example. (If not specified, the `run-example-e2e.js` script will run a default `yarn e2e` command.) Previously, the property specifying the test commands was called `e2e`. This is because in the past only e2e tests were run for docs examples. Since recently, some examples may specify commands for other types of tests (such as unit tests). Therefore, calling the property that holds the list of test commands `e2e` no longer makes sense and can be misleading to people looking at the configuration files. This commit renamed the property to the more generic `tests`. In the future, the `run-example-e2e.js` script (and corresponding npm script) should be renamed and refactored to also avoid giving the impression that only e2e tests are run. Discussed in: #36143 (comment)
diff --git a/aio/content/examples/component-interaction/example-config.json b/aio/content/examples/component-interaction/example-config.json
@@ -1,5 +1,5 @@
 {
-  "e2e": [
+  "tests": [
     {
       "cmd": "yarn",
       "args": [
diff --git a/aio/content/examples/forms-overview/example-config.json b/aio/content/examples/forms-overview/example-config.json
@@ -1,5 +1,5 @@
 {
-  "e2e": [
+  "tests": [
     {"cmd": "yarn", "args": ["test", "--browsers=ChromeHeadless", "--no-watch"]},
     {"cmd": "yarn", "args": ["e2e", "--prod", "--protractor-config=e2e/protractor-puppeteer.conf.js", "--no-webdriver-update", "--port={PORT}"]}
   ]
diff --git a/aio/content/examples/http/example-config.json b/aio/content/examples/http/example-config.json
@@ -1,6 +1,6 @@
 {
   "projectType": "testing",
-  "e2e": [
+  "tests": [
     {"cmd": "yarn", "args": ["test", "--browsers=ChromeHeadless", "--no-watch"]},
     {"cmd": "yarn", "args": ["e2e", "--prod", "--protractor-config=e2e/protractor-puppeteer.conf.js", "--no-webdriver-update", "--port={PORT}"]}
   ]
diff --git a/aio/content/examples/i18n/example-config.json b/aio/content/examples/i18n/example-config.json
@@ -1,6 +1,6 @@
 {
   "projectType": "i18n",
-  "e2e": [
+  "tests": [
     {
       "cmd": "yarn",
       "args": [
diff --git a/aio/content/examples/observables-in-angular/example-config.json b/aio/content/examples/observables-in-angular/example-config.json
@@ -1,5 +1,5 @@
 {
-  "e2e": [
+  "tests": [
     {
       "cmd": "yarn",
       "args": [ "tsc", "--project", "./tsconfig.app.json" ]
diff --git a/aio/content/examples/observables/example-config.json b/aio/content/examples/observables/example-config.json
@@ -1,5 +1,5 @@
 {
-  "e2e": [
+  "tests": [
     {
       "cmd": "yarn",
       "args": [ "tsc", "--project", "./tsconfig.app.json" ]
diff --git a/aio/content/examples/practical-observable-usage/example-config.json b/aio/content/examples/practical-observable-usage/example-config.json
@@ -1,5 +1,5 @@
 {
-  "e2e": [
+  "tests": [
     {
       "cmd": "yarn",
       "args": [ "tsc", "--project", "./tsconfig.app.json" ]
diff --git a/aio/content/examples/rx-library/example-config.json b/aio/content/examples/rx-library/example-config.json
@@ -1,5 +1,5 @@
 {
-  "e2e": [
+  "tests": [
     {
       "cmd": "yarn",
       "args": [ "tsc", "--project", "./tsconfig.app.json" ]
diff --git a/aio/content/examples/service-worker-getting-started/example-config.json b/aio/content/examples/service-worker-getting-started/example-config.json
@@ -1,6 +1,6 @@
 {
   "projectType": "service-worker",
-  "e2e": [
+  "tests": [
     {"cmd": "yarn", "args": ["e2e", "--protractor-config=e2e/protractor-puppeteer.conf.js", "--no-webdriver-update", "--port={PORT}"]},
     {"cmd": "yarn", "args": ["build", "--prod"]},
     {"cmd": "node", "args": ["--eval", "assert(fs.existsSync('./dist/ngsw.json'), 'ngsw.json is missing')"]},
diff --git a/aio/content/examples/setup/example-config.json b/aio/content/examples/setup/example-config.json
@@ -1,5 +1,5 @@
 {
-  "e2e": [
+  "tests": [
     {"cmd": "yarn", "args": ["test", "--browsers=ChromeHeadless", "--no-watch"]},
     {"cmd": "yarn", "args": ["e2e", "--prod", "--protractor-config=e2e/protractor-puppeteer.conf.js", "--no-webdriver-update", "--port={PORT}"]}
   ]
diff --git a/aio/content/examples/testing/example-config.json b/aio/content/examples/testing/example-config.json
@@ -1,6 +1,6 @@
 {
   "projectType": "testing",
-  "e2e": [
+  "tests": [
     {"cmd": "yarn", "args": ["test", "--browsers=ChromeHeadless", "--no-watch"]},
     {"cmd": "yarn", "args": ["e2e", "--prod", "--protractor-config=e2e/protractor-puppeteer.conf.js", "--no-webdriver-update", "--port={PORT}"]}
   ]
diff --git a/aio/content/examples/toh-pt6/example-config.json b/aio/content/examples/toh-pt6/example-config.json
@@ -1,5 +1,5 @@
 {
-  "e2e": [
+  "tests": [
     {"cmd": "yarn", "args": ["test", "--browsers=ChromeHeadless", "--no-watch"]},
     {"cmd": "yarn", "args": ["e2e", "--prod", "--protractor-config=e2e/protractor-puppeteer.conf.js", "--no-webdriver-update", "--port={PORT}"]}
   ]
diff --git a/aio/tools/examples/run-example-e2e.js b/aio/tools/examples/run-example-e2e.js
@@ -265,7 +265,7 @@ function runE2eTestsCLI(appDir, outputFile, bufferOutput, port) {
 
   // `--no-webdriver-update` is needed to preserve the ChromeDriver version already installed.
   const config = loadExampleConfig(appDir);
-  const commands = config.e2e || [{
+  const testCommands = config.tests || [{
     cmd: 'yarn',
     args: [
       'e2e',
@@ -277,7 +277,7 @@ function runE2eTestsCLI(appDir, outputFile, bufferOutput, port) {
   }];
   let bufferedOutput = `\n\n============== AIO example output for: ${appDir}\n\n`;
 
-  const e2eSpawnPromise = commands.reduce((prevSpawnPromise, {cmd, args}) => {
+  const e2eSpawnPromise = testCommands.reduce((prevSpawnPromise, {cmd, args}) => {
     // Replace the port placeholder with the specified port if present. Specs that
     // define their e2e test commands in the example config are able to use the
     // given available port. This ensures that the CLI tests can be run concurrently.

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`{`
`2`		`- "e2e": [`
	`2`	`+ "tests": [`
`3`	`3`	`{`
`4`	`4`	`"cmd": "yarn",`
`5`	`5`	`"args": [`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"projectType": "testing",`
`3`		`- "e2e": [`
	`3`	`+ "tests": [`
`4`	`4`	`{"cmd": "yarn", "args": ["test", "--browsers=ChromeHeadless", "--no-watch"]},`
`5`	`5`	`{"cmd": "yarn", "args": ["e2e", "--prod", "--protractor-config=e2e/protractor-puppeteer.conf.js", "--no-webdriver-update", "--port={PORT}"]}`
`6`	`6`	`]`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"projectType": "i18n",`
`3`		`- "e2e": [`
	`3`	`+ "tests": [`
`4`	`4`	`{`
`5`	`5`	`"cmd": "yarn",`
`6`	`6`	`"args": [`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"projectType": "service-worker",`
`3`		`- "e2e": [`
	`3`	`+ "tests": [`
`4`	`4`	`{"cmd": "yarn", "args": ["e2e", "--protractor-config=e2e/protractor-puppeteer.conf.js", "--no-webdriver-update", "--port={PORT}"]},`
`5`	`5`	`{"cmd": "yarn", "args": ["build", "--prod"]},`
`6`	`6`	`{"cmd": "node", "args": ["--eval", "assert(fs.existsSync('./dist/ngsw.json'), 'ngsw.json is missing')"]},`