knock this whole f'in thing

Author: dylanjha

README.md

@@ -209,13 +209,13 @@ See the [Mux-Node docs](https://muxinc.github.io/mux-node-sdk/identifiers.html)
 
 ## Development
 
-Run unit tests: `npm test` or `npm run test:unit`
+Run unit tests: `yarn test` or `yarn test:unit`
 
-Run integration tests: `npm run test:int`
+Run integration tests: `yarn test:int` - this will run integration tests with `nock` and `NOCK_BACK_MODE` set to `record`. This means that previously recorded API requests will be stubbed and any missing ones will be recorded.
 
-**Note**: running the integration tests will require you to configure the `MUX_TOKEN_ID` and `MUX_TOKEN_SECRET` environment variables with your Mux access token and secret. You should use the credentials for [email protected], where we generate views for this purpose ("watch-this" project).
+You can also run integration tests with real requests by running `yarn test:int:wild`. Make sure you have `MUX_TOKEN_ID` and `MUX_TOKEN_SECRET` set as environment variables so your requests are authenticated. This is useful to run locally to verify that actual API requests work as expected. When running the whole suite locally you might run into Mux API rate limits so keep that in mind.
 
-Integration tests do not get run on CI because of Mux API rate limits, so run them locally.
+**Pro Tip** Use mocha `-g` option to run only a specific test or group of tests. For example: `yarn test -g 'creates a new Assets'`.
 
 To generate the ESDocs, run:
 

package.json

@@ -21,8 +21,8 @@
     "docs": "esdoc",
     "test": "yarn test:unit",
     "test:unit": "mocha --recursive ./test/unit",
-    "test:int": "NOCK_BACK_MODE=wild mocha --recursive ./test/integration",
-    "test:int:record": "mocha --recursive ./test/integration --timeout 10000",
+    "test:int": "NOCK_BACK_MODE=record mocha --recursive ./test/integration --timeout 10000",
+    "test:int:wild": "NOCK_BACK_MODE=wild mocha --recursive ./test/integration --timeout 10000",
     "format": "eslint src/** test/** types/** --no-error-on-unmatched-pattern",
     "lint": "yarn format"
   },

test/integration/data/errors.spec.js

@@ -1,5 +1,6 @@
 const { expect } = require('chai');
 const Mux = require('../../../src/mux');
+const nockBack = require('nock').back;
 
 /** @test {Errors} */
 describe('Integration::Errors', () => {
@@ -10,11 +11,13 @@ describe('Integration::Errors', () => {
   describe('Errors.list', () => {
     /** @test {Errors.list} */
     it('Returns a list of playback errors', async () => {
+      const { nockDone } = await nockBack('Errors/list.json');
       const resp = await Data.Errors.list({
         filters: ['operating_system:linux'],
       });
       expect(resp.data).to.be.an('array');
       expect(resp.timeframe).to.be.an('array');
+      nockDone();
     });
   });
 });

test/integration/data/exports.spec.js

@@ -1,5 +1,6 @@
 const { expect } = require('chai');
 const Mux = require('../../../src/mux');
+const nockBack = require('nock').back;
 
 /** @test {Exports} */
 describe('Integration::Exports', () => {
@@ -10,10 +11,12 @@ describe('Integration::Exports', () => {
   describe('Exports.list', () => {
     /** @test {Exports.list} */
     it('Lists the available video view exports along with URLs to retrieve them', async () => {
+      const { nockDone } = await nockBack('Exports/list.json');
       const resp = await Data.Exports.list();
       expect(resp.data).to.be.an('array');
       expect(resp.total_row_count).to.be.greaterThan(6); // we should have 7 or 8
       expect(resp.timeframe).to.be.an('array');
+      nockDone();
     });
   });
 });

test/integration/data/filters.spec.js

@@ -1,5 +1,6 @@
 const { expect } = require('chai');
 const Mux = require('../../../src/mux');
+const nockBack = require('nock').back;
 
 /** @test {Filters} */
 describe('Integration::Filters', () => {
@@ -10,20 +11,24 @@ describe('Integration::Filters', () => {
   describe('Filters.list', () => {
     /** @test {Filters.list} */
     it('Lists all the filters broken out into basic and advanced', async () => {
+      const { nockDone } = await nockBack('Filters/list.json');
       const resp = await Data.Filters.list();
       expect(resp.timeframe).to.be.an('array');
       expect(resp.data.basic).to.be.an('array');
       expect(resp.data.advanced).to.be.an('array');
+      nockDone();
     });
   });
 
   /** @test {Filters.get} */
   describe('Filters.get', () => {
     /** @test {Filters.get} */
     it('Lists the values for a filter along with a total count of related views', async () => {
+      const { nockDone } = await nockBack('Filters/get.json');
       const resp = await Data.Filters.get('browser');
       expect(resp.data).to.be.an('array');
       expect(resp.timeframe).to.be.an('array');
+      nockDone();
     });
   });
 });

test/integration/data/incidents.spec.js

@@ -1,5 +1,6 @@
 const { expect } = require('chai');
 const Mux = require('../../../src/mux');
+const nockBack = require('nock').back;
 
 /** @test {Incidents} */
 describe('Integration::Incidents', () => {
@@ -10,11 +11,13 @@ describe('Integration::Incidents', () => {
   describe('Incidents.list', () => {
     /** @test {Incidents.list} */
     it('Returns a list of open incidents', async () => {
+      const { nockDone } = await nockBack('Incidents/list.json');
       const resp = await Data.Incidents.list({
         status: 'open',
       });
       expect(resp.data).to.be.an('array');
       expect(resp.timeframe).to.be.an('array');
+      nockDone();
     });
   });
 });

test/integration/data/metrics.spec.js

@@ -1,5 +1,6 @@
 const { expect } = require('chai');
 const Mux = require('../../../src/mux');
+const nockBack = require('nock').back;
 
 /** @test {Metrics} */
 describe('Integration::Metrics', () => {
@@ -10,54 +11,64 @@ describe('Integration::Metrics', () => {
   describe('Metrics.breakdown', () => {
     /** @test {Metrics.breakdown} */
     it('Lists all of the values across every breakdown for a specific metric', async () => {
+      const { nockDone } = await nockBack('Metrics/breakdown.json');
       const resp = await Data.Metrics.breakdown('aggregate_startup_time', {
         group_by: 'browser',
       });
       expect(resp.data).to.be.an('array');
       expect(resp.timeframe).to.be.an('array');
+      nockDone();
     });
   });
 
   /** @test {Metrics.comparision} */
   describe('Metrics.comparision', () => {
     /** @test {Metrics.comparision} */
     it('Lists the breakdown values for a specific metric', async () => {
+      const { nockDone } = await nockBack('Metrics/comparison.json');
       const resp = await Data.Metrics.comparison({
         value: 'Safari',
         dimension: 'browser',
       });
       expect(resp.data).to.be.an('array');
       expect(resp.timeframe).to.be.an('array');
+      nockDone();
     });
   });
 
   /** @test {Metrics.insights} */
   describe('Metrics.insights', () => {
     /** @test {Metrics.insights} */
     it('Returns a list of insights for a metric', async () => {
+      const { nockDone } = await nockBack('Metrics/insights.json');
       const resp = await Data.Metrics.insights('video_startup_time');
       expect(resp.data).to.be.an('array');
       expect(resp.timeframe).to.be.an('array');
+      nockDone();
     });
   });
 
   /** @test {Metrics.overall} */
   describe('Metrics.overall', () => {
     /** @test {Metrics.overall} */
     it('Returns the overall value for a specific metric, as well as the total view count, watch time, and the Mux Global metric value for the metric', async () => {
+      const { nockDone } = await nockBack('Metrics/overall.json');
       const resp = await Data.Metrics.overall('video_startup_time');
       expect(resp.data).to.be.an('object');
       expect(resp.timeframe).to.be.an('array');
+      nockDone();
     });
   });
 
   /** @test {Metrics.timeseries} */
   describe('Metrics.timeseries', () => {
     /** @test {Metrics.timeseries} */
     it('Returns the overall value for a specific metric, as well as the total view count, watch time, and the Mux Global metric value for the metric', async () => {
+      const { nockDone } = await nockBack('Metrics/timeseries.json');
       const resp = await Data.Metrics.timeseries('video_startup_time');
       expect(resp.data).to.be.an('array');
       expect(resp.timeframe).to.be.an('array');
+      nockDone();
     });
   });
 });

test/integration/data/real_time.spec.js

@@ -1,5 +1,6 @@
 const { expect } = require('chai');
 const Mux = require('../../../src/mux');
+const nockBack = require('nock').back;
 
 /** @test {RealTime} */
 describe('Integration::RealTime', () => {
@@ -10,59 +11,70 @@ describe('Integration::RealTime', () => {
   describe('RealTime.dimensions', () => {
     /** @test {RealTime.dimensions} */
     it('List of available real-time dimensions', async () => {
+      const { nockDone } = await nockBack('RealTime/dimensions.json');
       const resp = await Data.RealTime.dimensions();
       expect(resp.data).to.be.an('array');
       expect(resp.data[0]).to.be.an('object');
+      nockDone();
     });
   });
 
   /** @test {RealTime.metrics} */
   describe('RealTime.metrics', () => {
     /** @test {RealTime.metrics} */
     it('List available real-time metrics', async () => {
+      const { nockDone } = await nockBack('RealTime/metrics.json');
       const resp = await Data.RealTime.metrics();
       expect(resp.data).to.be.an('array');
       expect(resp.data[0]).to.be.an('object');
+      nockDone();
     });
   });
 
   /** @test {RealTime.breakdown} */
   describe('RealTime.breakdown', () => {
     /** @test {RealTime.breakdown} */
     it('Get breakdown information for a specific dimension and metric', async () => {
+      const { nockDone } = await nockBack('RealTime/breakdown.json');
+      const timestamp = 1592357452; // freeze this time for nock
       const resp = await Data.RealTime.breakdown(
         'playback-failure-percentage',
         {
           dimension: 'asn',
-          timestamp: Math.floor(new Date().getTime() / 1000),
+          timestamp,
           filters: ['operating_system:windows', 'country:US'],
         }
       );
       expect(resp.data).to.be.an('array');
+      nockDone();
     });
   });
 
   /** @test {RealTime.histogramTimeseries} */
   describe('RealTime.histogramTimeseries', () => {
     /** @test {RealTime.histogramTimeseries} */
     it('List histogram timeseries information for a specific metric', async () => {
+      const { nockDone } = await nockBack('RealTime/histogramTimeseries.json');
       const resp = await Data.RealTime.histogramTimeseries(
         'video-startup-time',
         { filters: ['operating_system:windows', 'country:US'] }
       );
       expect(resp.data).to.be.an('array');
+      nockDone();
     });
   });
 
   /** @test {RealTime.timeseries} */
   describe('RealTime.timeseries', () => {
     /** @test {RealTime.timeseries} */
     it('List timeseries information for the playback-failure-percentage metric along with the number of concurrent viewers for the Windows operating system in the US', async () => {
+      const { nockDone } = await nockBack('RealTime/timeseries.json');
       const resp = await Data.RealTime.timeseries(
         'playback-failure-percentage',
         { filters: ['operating_system:windows', 'country:US'] }
       );
       expect(resp.data).to.be.an('array');
+      nockDone();
     });
   });
 });

test/integration/data/video_views.spec.js

@@ -1,5 +1,6 @@
 const { expect } = require('chai');
 const Mux = require('../../../src/mux');
+const nockBack = require('nock').back;
 
 /** @test {VideoViews} */
 describe('Integration::VideoViews', () => {
@@ -10,21 +11,25 @@ describe('Integration::VideoViews', () => {
   describe('VideoViews.list', () => {
     /** @test {VideoViews.list} */
     it('Returns a list of video views for a property that occurred within the specified timeframe', async () => {
+      const { nockDone } = await nockBack('VideoViews/list.json');
       const resp = await Data.VideoViews.list({
         viewer_id: 'test',
         order_direction: 'asc',
       });
       expect(resp.data).to.be.an('array');
+      nockDone();
     });
   });
 
   /** @test {VideoViews.get} */
   describe('VideoViews.get', () => {
     /** @test {VideoViews.get} */
     it('Returns the details for a single video view', async () => {
+      const { nockDone } = await nockBack('VideoViews/listAndGet.json');
       const resp = await Data.VideoViews.list();
       const view = await Data.VideoViews.get(resp.data[0].id);
       expect(view).to.be.an('object');
+      nockDone();
     });
   });
 });

test/integration/helper.js

@@ -2,7 +2,6 @@ const path = require('path');
 const nockBack = require('nock').back;
 
 before(() => {
-  console.log('debug', nockBack.currentMode);
   // If we decide to use nock with other modules we should move this to a test helper
   nockBack.fixtures = path.join(__dirname, '/nockFixtures');
 });