[+coverage] unit tests for ArtifactsManager.js and ArtifactPlugin.js

detox/package.json

@@ -67,8 +67,6 @@
       "src/artifacts/log",
       "src/artifacts/screenshot",
       "src/artifacts/video",
-      "src/artifacts/templates/plugin",
-      "src/artifacts/ArtifactsManager.js",
       ".*Driver.js",
       "EmulatorTelnet.js",
       "Emulator.js",

detox/src/artifacts/ArtifactsManager.js

@@ -3,35 +3,32 @@ const fs = require('fs-extra');
 const path = require('path');
 const log = require('npmlog');
 const argparse = require('../utils/argparse');
-const environment = require('../utils/environment');
 const logError = require('../utils/logError');
 const DetoxRuntimeError = require('../errors/DetoxRuntimeError');
 const ArtifactPathBuilder = require('./utils/ArtifactPathBuilder');
 
 class ArtifactsManager {
-  constructor() {
+  constructor(pathBuilder) {
     this.onBeforeResetDevice = this.onBeforeResetDevice.bind(this);
     this.onResetDevice = this.onResetDevice.bind(this);
     this.onBeforeLaunchApp = this.onBeforeLaunchApp.bind(this);
     this.onLaunchApp = this.onLaunchApp.bind(this);
-    this._executeIdleCallback = this._executeIdleCallback.bind(this);
-
     this.onTerminate = _.once(this.onTerminate.bind(this));
+    this._executeIdleCallback = this._executeIdleCallback.bind(this);
 
     this._idlePromise = Promise.resolve();
     this._onIdleCallbacks = [];
     this._activeArtifacts = [];
     this._artifactPluginsFactories = [];
     this._artifactPlugins = [];
+    this._pathBuilder = pathBuilder || new ArtifactPathBuilder({
+      artifactsRootDir: argparse.getArgValue('artifacts-location') || 'artifacts',
+    });
 
     this._deviceId = '';
     this._bundleId = '';
     this._pid = NaN;
 
-    const pathBuilder = new ArtifactPathBuilder({
-      artifactsRootDir: argparse.getArgValue('artifacts-location') || 'artifacts',
-    });
-
     this.artifactsApi = {
       getDeviceId: () => {
         if (!this._deviceId) {
@@ -54,17 +51,17 @@ class ArtifactsManager {
       },
 
       getPid: () => {
-        if (!this._pid) {
+        if (isNaN(this._pid)) {
           throw new DetoxRuntimeError({
-            message: 'Detox Artifacts API had no app pid at the time of calling',
+            message: 'Detox Artifacts API had no app PID at the time of calling',
           });
         }
 
         return this._pid;
       },
 
       preparePathForArtifact: async (artifactName, testSummary) => {
-        const artifactPath = pathBuilder.buildPathForTestArtifact(artifactName, testSummary);
+        const artifactPath = this._pathBuilder.buildPathForTestArtifact(artifactName, testSummary);
         const artifactDir = path.dirname(artifactPath);
         await fs.ensureDir(artifactDir);
 
@@ -75,12 +72,15 @@ class ArtifactsManager {
         this._activeArtifacts.push(artifact);
       },
 
-      untrackArtifact(artifact) {
+      untrackArtifact: (artifact) => {
         _.pull(this._activeArtifacts, artifact);
       },
 
       requestIdleCallback: (callback, caller) => {
-        callback._from = caller.name;
+        if (caller) {
+          callback._from = caller.name;
+        }
+
         this._onIdleCallbacks.push(callback);
 
         this._idlePromise = this._idlePromise.then(() => {
@@ -123,14 +123,26 @@ class ArtifactsManager {
     this._deviceId = deviceId;
     this._bundleId = bundleId;
 
-    if (isFirstTime) {
-      this._artifactPlugins = this._artifactPluginsFactories.map((factory) => {
-        return factory(this.artifactsApi);
-      });
-    } else {
-      // TODO: implement this lifecycle event
-      // await this._emit('onBeforeRelaunchApp', [{ deviceId, bundleId }]);
-    }
+    return isFirstTime
+      ? this._onBeforeLaunchAppFirstTime()
+      : this._onBeforeRelaunchApp({ deviceId, bundleId });
+  }
+
+  async _onBeforeLaunchAppFirstTime() {
+    this._artifactPlugins = this._instantiateArtifactPlugins();
+  }
+
+  _instantiateArtifactPlugins() {
+    return this._artifactPluginsFactories.map((factory) => {
+      return factory(this.artifactsApi);
+    });
+  }
+
+  async _onBeforeRelaunchApp() {
+    await this._emit('onBeforeRelaunchApp', [{
+      deviceId: this._deviceId,
+      bundleId: this._bundleId,
+    }]);
   }
 
   async onLaunchApp({ deviceId, bundleId, pid }) {
@@ -177,7 +189,7 @@ class ArtifactsManager {
     }
 
     log.info('ArtifactsManager', 'finalizing all artifacts, this can take some time');
-    await Promise.all(this._artifactPlugins.map(plugin => plugin.onTerminate()));
+    await this._emit('onTerminate', []);
     await Promise.all(this._onIdleCallbacks.splice(0).map(this._executeIdleCallback));
     await this._idlePromise;