Applying Linter on Tests (#201)

* Upgraded tslint to latest

* Addressing more lint errors

* Addressed all linter errors

* Added align rule back

* Further tweaks to rules

* Fixing test compilation error

* Fixing more test compilation errors

* More minor improvements to typings

* Replacing remaining references to Object type

* Updated packages and merged with master

* Fixing lint errors in unit tests

* Fixing remaining lint errors in unit tests

* Updating configuration to lint all source and test files at npm lint

* Running different lint targets in parallel

Author: hiranya911

package.json

@@ -7,12 +7,15 @@
   "homepage": "https://firebase.google.com/",
   "scripts": {
     "build": "gulp build",
-    "lint": "tslint --project tsconfig-lint.json --format stylish",
+    "lint": "run-p lint:src lint:unit lint:integration",
     "test": "run-s lint test:unit",
     "integration": "run-s build test:integration",
     "test:unit": "mocha test/unit/*.spec.ts --compilers ts:ts-node/register",
     "test:integration": "mocha test/integration/*.ts --slow 5000 --compilers ts:ts-node/register",
-    "test:coverage": "nyc npm run test:unit"
+    "test:coverage": "nyc npm run test:unit",
+    "lint:src": "tslint --format stylish -p tsconfig.json",
+    "lint:unit": "tslint -c tslint-test.json --format stylish test/unit/*.ts test/unit/**/*.ts",
+    "lint:integration": "tslint -c tslint-test.json --format stylish test/integration/*.ts"
   },
   "nyc": {
     "extension": [

test/integration/app.spec.ts

@@ -28,21 +28,21 @@ describe('admin', () => {
   });
 
   it('does not load Firestore by default', () => {
-    let gcloud = require.cache[require.resolve('@google-cloud/firestore')];
+    const gcloud = require.cache[require.resolve('@google-cloud/firestore')];
     expect(gcloud).to.be.undefined;
   });
 
   it('loads Firestore when calling admin.firestore', () => {
     const firestoreNamespace = admin.firestore;
     expect(firestoreNamespace).to.not.be.null;
-    let gcloud = require.cache[require.resolve('@google-cloud/firestore')];
+    const gcloud = require.cache[require.resolve('@google-cloud/firestore')];
     expect(gcloud).to.not.be.undefined;
   });
 });
 
 describe('admin.app', () => {
   it('admin.app() returns the default App', () => {
-    let app = admin.app();
+    const app = admin.app();
     expect(app).to.deep.equal(defaultApp);
     expect(app.name).to.equal('[DEFAULT]');
     expect(app.options.databaseURL).to.equal(databaseUrl);
@@ -51,7 +51,7 @@ describe('admin.app', () => {
   });
 
   it('admin.app("null") returns the App named "null"', () => {
-    let app = admin.app('null');
+    const app = admin.app('null');
     expect(app).to.deep.equal(nullApp);
     expect(app.name).to.equal('null');
     expect(app.options.databaseURL).to.equal(databaseUrl);
@@ -60,7 +60,7 @@ describe('admin.app', () => {
   });
 
   it('admin.app("nonNull") returns the App named "nonNull"', () => {
-    let app = admin.app('nonNull');
+    const app = admin.app('nonNull');
     expect(app).to.deep.equal(nonNullApp);
     expect(app.name).to.equal('nonNull');
     expect(app.options.databaseURL).to.equal(databaseUrl);
@@ -69,15 +69,15 @@ describe('admin.app', () => {
   });
 
   it('namespace services are attached to the default App', () => {
-    let app = admin.app();
+    const app = admin.app();
     expect(admin.auth(app).app).to.deep.equal(app);
     expect(admin.database(app).app).to.deep.equal(app);
     expect(admin.messaging(app).app).to.deep.equal(app);
     expect(admin.storage(app).app).to.deep.equal(app);
   });
 
   it('namespace services are attached to the named App', () => {
-    let app = admin.app('null');
+    const app = admin.app('null');
     expect(admin.auth(app).app).to.deep.equal(app);
     expect(admin.database(app).app).to.deep.equal(app);
     expect(admin.messaging(app).app).to.deep.equal(app);

test/integration/auth.spec.ts

@@ -15,7 +15,6 @@
  */
 
 import * as admin from '../../lib/index';
-import {expect} from 'chai';
 import * as chai from 'chai';
 import * as chaiAsPromised from 'chai-as-promised';
 import firebase = require('firebase');
@@ -25,6 +24,8 @@ import {generateRandomString, projectId, apiKey} from './setup';
 chai.should();
 chai.use(chaiAsPromised);
 
+const expect = chai.expect;
+
 const newUserUid = generateRandomString(20);
 const nonexistentUid = generateRandomString(20);
 const testPhoneNumber = '+11234567890';
@@ -64,7 +65,7 @@ describe('admin.auth', () => {
   });
 
   it('createUser() creates a new user when called without a UID', () => {
-    let newUserData = clone(mockUserData);
+    const newUserData = clone(mockUserData);
     newUserData.email = generateRandomString(20) + '@example.com';
     newUserData.phoneNumber = testPhoneNumber2;
     return admin.auth().createUser(newUserData)
@@ -79,7 +80,7 @@ describe('admin.auth', () => {
   });
 
   it('createUser() creates a new user with the specified UID', () => {
-    let newUserData: any = clone(mockUserData);
+    const newUserData: any = clone(mockUserData);
     newUserData.uid = newUserUid;
     return admin.auth().createUser(newUserData)
       .then((userRecord) => {
@@ -92,7 +93,7 @@ describe('admin.auth', () => {
   });
 
   it('createUser() fails when the UID is already in use', () => {
-    let newUserData: any = clone(mockUserData);
+    const newUserData: any = clone(mockUserData);
     newUserData.uid = newUserUid;
     return admin.auth().createUser(newUserData)
       .should.eventually.be.rejected.and.have.property('code', 'auth/uid-already-exists');
@@ -120,7 +121,7 @@ describe('admin.auth', () => {
   });
 
   it('listUsers() returns up to the specified number of users', () => {
-    let promises: Promise<admin.auth.UserRecord>[] = [];
+    const promises: Array<Promise<admin.auth.UserRecord>> = [];
     uids.forEach((uid) => {
       const tempUserData = {
         uid,
@@ -168,7 +169,7 @@ describe('admin.auth', () => {
       .then((decodedIdToken) => {
         // Verification should succeed. Revoke that user's session.
         return new Promise((resolve) => setTimeout(() => resolve(
-          admin.auth().revokeRefreshTokens(decodedIdToken.sub)
+          admin.auth().revokeRefreshTokens(decodedIdToken.sub),
         ), 1000));
       })
       .then(() => {
@@ -224,7 +225,7 @@ describe('admin.auth', () => {
       })
       .then((decodedIdToken) => {
         // Confirm expected claims set on the user's ID token.
-        for (let key in customClaims) {
+        for (const key in customClaims) {
           if (customClaims.hasOwnProperty(key)) {
             expect(decodedIdToken[key]).to.equal(customClaims[key]);
           }
@@ -331,12 +332,12 @@ function deletePhoneNumberUser(phoneNumber) {
 /**
  * Runs cleanup routine that could affect outcome of tests and removes any
  * intermediate users created.
- * 
+ *
  * @return {Promise} A promise that resolves when test preparations are ready.
  */
 function cleanup() {
   // Delete any existing users that could affect the test outcome.
-  let promises: Promise<void>[] = [
+  const promises: Array<Promise<void>> = [
     deletePhoneNumberUser(testPhoneNumber),
     deletePhoneNumberUser(testPhoneNumber2),
     deletePhoneNumberUser(nonexistentPhoneNumber),
@@ -351,7 +352,7 @@ function cleanup() {
           if (error.code !== 'auth/user-not-found') {
             throw error;
           }
-        })
+        }),
     );
   });
   return Promise.all(promises);

test/integration/database.spec.ts

@@ -15,7 +15,6 @@
  */
 
 import * as admin from '../../lib/index';
-import {expect} from 'chai';
 import * as chai from 'chai';
 import * as chaiAsPromised from 'chai-as-promised';
 import url = require('url');
@@ -29,6 +28,8 @@ const chalk = require('chalk');
 chai.should();
 chai.use(chaiAsPromised);
 
+const expect = chai.expect;
+
 const path = 'adminNodeSdkManualTest';
 
 describe('admin.database', () => {
@@ -99,7 +100,7 @@ describe('admin.database', () => {
     it('once() returns the current value of the reference', () => {
       return ref.once('value')
         .then((snapshot) => {
-          let value = snapshot.val();
+          const value = snapshot.val();
           expect(value.success).to.be.true;
           expect(typeof value.timestamp).to.equal('number');
         });
@@ -141,7 +142,7 @@ describe('admin.database', () => {
     it('once() returns the current value of the reference', () => {
       return refWithUrl.once('value')
         .then((snapshot) => {
-          let value = snapshot.val();
+          const value = snapshot.val();
           expect(value.success).to.be.true;
           expect(typeof value.timestamp).to.equal('number');
         });
@@ -165,6 +166,6 @@ function addValueEventListener(
     callback: (s: admin.database.DataSnapshot) => any) {
   // Check for type compilation. This method is not invoked by any tests. But it will
   // trigger a TS compilation failure if the RTDB typings were not loaded correctly.
-  let eventType: admin.database.EventType = 'value';
+  const eventType: admin.database.EventType = 'value';
   db.ref().on(eventType, callback);
 }

test/integration/firestore.spec.ts

@@ -15,7 +15,6 @@
  */
 
 import * as admin from '../../lib/index';
-import {expect} from 'chai';
 import * as chai from 'chai';
 import * as chaiAsPromised from 'chai-as-promised';
 import {clone} from 'lodash';
@@ -24,6 +23,8 @@ import {DocumentReference} from '@google-cloud/firestore';
 chai.should();
 chai.use(chaiAsPromised);
 
+const expect = chai.expect;
+
 const mountainView = {
   name: 'Mountain View',
   population: 77846,
@@ -49,31 +50,31 @@ describe('admin.firestore', () => {
 
   it('supports basic data access', () => {
     return reference.set(mountainView)
-      .then(result => {
+      .then((result) => {
         return reference.get();
       })
-      .then(snapshot => {
-        let data = snapshot.data();
+      .then((snapshot) => {
+        const data = snapshot.data();
         expect(data).to.deep.equal(mountainView);
         return reference.delete();
       })
-      .then(result => {
+      .then((result) => {
         return reference.get();
       })
-      .then(snapshot => {
+      .then((snapshot) => {
         expect(snapshot.exists).to.be.false;
       });
   }).timeout(5000);
 
   it('admin.firestore.FieldValue.serverTimestamp() provides a server-side timestamp', () => {
-    let expected: any = clone(mountainView);
+    const expected: any = clone(mountainView);
     expected.timestamp = admin.firestore.FieldValue.serverTimestamp();
     return reference.set(expected)
-      .then(result => {
+      .then((result) => {
         return reference.get();
       })
-      .then(snapshot => {
-        let data = snapshot.data();
+      .then((snapshot) => {
+        const data = snapshot.data();
         expect(data.timestamp).is.not.null;
         expect(data.timestamp instanceof Date).is.true;
         return reference.delete();
@@ -97,16 +98,16 @@ describe('admin.firestore', () => {
     const source = admin.firestore().collection('cities').doc();
     const target = admin.firestore().collection('cities').doc();
     return source.set(mountainView)
-      .then(result => {
+      .then((result) => {
         return target.set({name: 'Palo Alto', sisterCity: source});
       })
-      .then(result => {
+      .then((result) => {
         return target.get();
       })
-      .then(snapshot => {
-        let data = snapshot.data();
+      .then((snapshot) => {
+        const data = snapshot.data();
         expect(data.sisterCity.path).to.deep.equal(source.path);
-        let promises = [];
+        const promises = [];
         promises.push(source.delete());
         promises.push(target.delete());
         return Promise.all(promises);
@@ -121,10 +122,10 @@ describe('admin.firestore', () => {
       logs.push(log);
     });
     return source.set({name: 'San Francisco'})
-      .then(result => {
+      .then((result) => {
         return source.delete();
       })
-      .then(result => {
+      .then((result) => {
         expect(logs.length).greaterThan(0);
       });
   }).timeout(5000);

test/integration/messaging.spec.ts

@@ -15,13 +15,14 @@
  */
 
 import * as admin from '../../lib/index';
-import {expect} from 'chai';
 import * as chai from 'chai';
 import * as chaiAsPromised from 'chai-as-promised';
 
 chai.should();
 chai.use(chaiAsPromised);
 
+const expect = chai.expect;
+
 // The registration token and notification key have the proper format, but are not guaranteed to
 // work. The intention of these integration tests is that the endpoints returns the proper payload,
 // but it is hard to ensure these tokens will always be valid. The tests below should still pass

test/integration/setup.ts

@@ -44,7 +44,7 @@ before(() => {
     console.log(chalk.red(
       'The integration test suite requires a service account JSON file for a ' +
       'Firebase project to be saved to `test/resources/key.json`.',
-      error
+      error,
     ));
     throw error;
   }
@@ -55,7 +55,7 @@ before(() => {
     console.log(chalk.red(
       'The integration test suite requires an API key for a ' +
       'Firebase project to be saved to `test/resources/apikey.txt`.',
-      error
+      error,
     ));
     throw error;
   }

test/integration/storage.spec.ts

@@ -15,7 +15,6 @@
  */
 
 import * as admin from '../../lib/index';
-import {expect} from 'chai';
 import * as chai from 'chai';
 import * as chaiAsPromised from 'chai-as-promised';
 import {Bucket, File} from '@google-cloud/storage';
@@ -25,6 +24,8 @@ import {projectId} from './setup';
 chai.should();
 chai.use(chaiAsPromised);
 
+const expect = chai.expect;
+
 describe('admin.storage', () => {
   it('bucket() returns a handle to the default bucket', () => {
     const bucket: Bucket = admin.storage().bucket();