chore(website): fix website tests (#4080)

Also added npm command `compile_to_es5` to make running the website tests easier

Author: sjelin

gulpfile.js

@@ -98,6 +98,14 @@ gulp.task('tsc:spec', function(done) {
   runSpawn(done, 'node', ['node_modules/typescript/bin/tsc', '-p', 'ts_spec_config.json']);
 });
 
+gulp.task('tsc:es5', function(done) {
+  runSpawn(done, './scripts/compile_to_es5.sh');
+});
+
+gulp.task('compile_to_es5', function(done) {
+  runSequence('checkVersion', 'tsc:es5', 'built:copy', done);
+});
+
 gulp.task('prepublish', function(done) {
   runSequence('checkVersion', 'jshint', 'tsc', 'built:copy', done);
 });

package.json

@@ -74,7 +74,8 @@
     "pretest": "gulp pretest",
     "start": "cd testapp && npm start",
     "test": "node scripts/test.js",
-    "website": "cd website && npm start"
+    "website": "cd website && npm start",
+    "compile_to_es5": "gulp compile_to_es5"
   },
   "license": "MIT",
   "engines": {

scripts/compile_to_es5.sh

@@ -0,0 +1,39 @@
+#!/bin/sh
+cd "$( dirname "${BASH_SOURCE[0]}" )/.."
+
+# Check number of parameters
+if [ "$#" -gt 0 ]; then
+  echo "Usage: ./scripts/compile_to_es5.sh"
+  exit 1
+fi
+
+echo "Getting types for es6 promises..."
+npm install @types/es6-promise
+if [ $? -ne 0 ]; then
+  echo -e "\033[0;31m" 1>&2 # Red
+  echo "Couldn't get types for es6 promises."
+  echo -e "\033[0m" 1>&2 # Normal Color
+  exit 1
+fi
+
+echo "Compiling down to es5..."
+node node_modules/typescript/bin/tsc --target es5
+if [ $? -ne 0 ]; then
+  echo -e "\033[0;31m" 1>&2 # Red
+  echo "Couldn't compile for es5."
+  echo -e "\033[0m" 1>&2 # Normal Color
+  npm remove @types/es6-promise
+  exit 1
+fi
+
+echo "Uninstalling types for es6 promises..."
+npm remove @types/es6-promise
+if [ $? -ne 0 ]; then
+  echo -e "\033[0;33m" 1>&2 # Yellow
+  echo "Warning: couldn't uninstall types for es6 promises"
+  echo -e "\033[0m" 1>&2 # Normal Color
+fi
+
+echo -e "\033[0;32m" # Green
+echo "Compiled to es5"
+echo -e "\033[0m" 1>&2 # Normal Color

scripts/generate-docs.sh

@@ -62,30 +62,13 @@ if [ $? -ne 0 ]; then
   exit 1
 fi
 
-echo "Getting types for es6 promises..."
-npm install @types/es6-promise
+# Compile to es5
+./scripts/compile_to_es5.sh
 if [ $? -ne 0 ]; then
-  echo -e "\033[0;31m" 1>&2 # Red
-  echo "Couldn't get types for es6 promises."
-  echo -e "\033[0m" 1>&2 # Normal Color
-  git checkout "${EXEC_BRANCH}"
-  exit 1
-fi
-
-echo "Compiling down to es5..."
-node node_modules/typescript/bin/tsc --target es5
-if [ $? -ne 0 ]; then
-  echo -e "\033[0;31m" 1>&2 # Red
-  echo "Couldn't compile for es5."
-  echo -e "\033[0m" 1>&2 # Normal Color
-  npm remove @types/es6-promise
   git checkout "${EXEC_BRANCH}"
   exit 1
 fi
 
-# Remove unneeded type
-npm remove @types/es6-promise
-
 echo "Installing the testapp..."
 npm run install_testapp
 if [ $? -ne 0 ]; then

website/README.md

@@ -6,6 +6,7 @@ Generates the documentation for the protractor website.
 ## How to run
 
 ```shell
+npm run compile_to_es5
 cd website/
 npm install
 npm run build

website/gulpfile.js

@@ -30,16 +30,34 @@ gulp.task('clean', function(cb) {
 
 // Generate the table of contents json file using Dgeni. This is output to
 // docgen/build/toc.json
-gulp.task('dgeni', function() {
+gulp.task('dgeni', function(done) {
   var packages = [require('./docgen/dgeni-config')];
   var dgeni = new Dgeni(packages);
 
   dgeni.generate().then(function(docs) {
     console.log(docs.length, 'docs generated');
   }).then(function() {
+    // Check that docs were generated correctly
+    var toc = require('./docgen/build/toc.json');
+    if (!toc || !Array.isArray(toc.items)) {
+      return Promise.reject('Generated toc.json file is malformatted');
+    }
+    var isBrowser = function(item) {
+      return item.alias == 'browser';
+    };
+    if (!toc.items.some(isBrowser)) {
+      return Promise.reject('Generated toc.json missing docs for Protractor function.');
+    }
+
     // Copy files over
     gulp.src(['docgen/build/*.json'])
         .pipe(gulp.dest(paths.outputDir + '/apiDocs'));
+    done();
+  }).catch(function(error) {
+    done(
+        'Could not generate docs.  ' +
+        'Try running `npm run compile_to_es5` from Protractor\'s root folder.\n' +
+        'Origonal Error: ' + error);
   });
 });
 

website/package.json

@@ -29,8 +29,5 @@
     "prestart": "npm install && npm run prepublish",
     "start": "gulp liveReload",
     "test": "node run-tests.js"
-  },
-  "engines": {
-    "node": ">=4.0.0 <5.0.x"
   }
 }

website/test/e2e/api_spec.js

@@ -94,8 +94,9 @@ describe('Api', function() {
 
     // Then ensure the child functions are shown.
     expect(apiPage.getChildFunctionNames()).toEqual([
-      'clone', 'all', 'filter', 'get', 'first', 'last', '$$', 'count', 'locator',
-      'then', 'each', 'map', 'reduce', 'evaluate', 'allowAnimations']);
+      'clone', 'all', 'filter', 'get', 'first', 'last', '$$', 'count',
+      'isPresent', 'locator', 'then', 'each', 'map', 'reduce', 'evaluate',
+      'allowAnimations']);
   });
 
   it('should show element functions', function() {
@@ -114,12 +115,13 @@ describe('Api', function() {
 
     // Then ensure the child functions are shown.
     expect(apiPage.getChildFunctionNames()).toEqual([
-      'getProcessedConfig', 'forkNewDriverInstance', 'restart',
+      'angularAppRoot', 'waitForAngularEnabled', 'getProcessedConfig',
+      'forkNewDriverInstance', 'restart', 'restartSync',
       'useAllAngular2AppRoots', 'waitForAngular', 'findElement', 'findElements',
       'isElementPresent', 'addMockModule', 'clearMockModules',
       'removeMockModule', 'getRegisteredMockModules', 'get', 'refresh',
       'navigate', 'setLocation', 'getLocationAbsUrl', 'debugger', 'enterRepl',
-      'pause', 'wrapDriver']);
+      'explore', 'pause', 'controlFlowIsEnabled']);
   });
 
   it('should view inherited function', function() {
@@ -140,6 +142,9 @@ describe('Api', function() {
       'protractor objects', function() {
         expect(apiPage.getAdultNames().then(function(names) {
           return names[names.indexOf('browser') + 1];
+        })).toBe('ExtendedWebDriver');
+        expect(apiPage.getAdultNames().then(function(names) {
+          return names[names.indexOf('ExtendedWebDriver') + 1];
         })).toBe('webdriver.WebDriver');
   });
 });

website/test/unit/api-controller-spec.js

@@ -203,7 +203,7 @@ describe('ApiCtrl', function() {
       var item = scope.items[0];
       expect(item.title).toBe('name2');
       expect(item.base.name).toBe('name1');
-      expect(item.base.items.length).toBe(1);
+      expect(item.base.children.length).toBe(1);
     });
   });