Make osn-tests easier to run locally and in appveyor (#328)

* Make osn-tests easier to run locally and on appveyor

* Add missing tsconfig.json file

* Remove local path from index.ts

* Add Debug flag to local build script

* Removed clean script because git clean can prevent some node_module
folders from being removed

* Remove index.ts

This file is generated by CMake, there is no need to track it in the
repository

Author: prsdamasceno

CMakeLists.txt

@@ -52,6 +52,12 @@ if(WIN32)
 		${PROJECT_SOURCE_DIR}/tests/helpers/obs.js
 		@ONLY
 	)
+
+	configure_file(
+		${PROJECT_SOURCE_DIR}/cmake/index.ts.in
+		${PROJECT_SOURCE_DIR}/tests/osn-tests/osn/index.ts
+		@ONLY
+	)
 endif()
 
 add_subdirectory(lib-streamlabs-ipc)

appveyor.yml

@@ -42,13 +42,8 @@ after_build:
   - copy "C:\Program Files (x86)\Microsoft Visual Studio\2017\Community\Common7\Tools\ucrtbase.dll" "%SLFullDistributePath%\obs-studio-node\"
   - tar cvaf "%UnsignedArtifact%.tar.gz" -C "%SLFullDistributePath%" "obs-studio-node"
 
-before_test:
-  - cmd: cd tests\osn-tests
-  - cmd: yarn install
-
 test_script:
   - cmd: yarn run test
-  - cmd: cd ..\..
 
 before_deploy:
   - cmd: ci\copy-signed-binaries.cmd
@@ -79,4 +74,4 @@ artifacts:
   - path: $(UnsignedArtifact).tar.gz
     name: Unsigned Aritfact
 
-test: on
+test: on

cmake/index.ts.in

@@ -0,0 +1,4 @@
+export * from '@CMAKE_INSTALL_PREFIX@/index';
+
+const wd: string = "@CMAKE_INSTALL_PREFIX@";
+export {wd};

package.json

@@ -15,17 +15,29 @@
   "main": "./index.js",
   "types": "./index.d.ts",
   "scripts": {
-    "clean": "git clean -fxd",
     "build:bindings": "cmake-js configure -a x64 --CDCMAKE_PREFIX_INSTALL=distribute && cmake --build build --target install --config Release",
     "build:javascript": "tsc -p js",
-    "build:docs": "typedoc --out docs"
+    "build:docs": "typedoc --out docs",
+    "local:config": "yarn install && git submodule update --init --recursive --force && cmake -Bbuild -H. -G\"Visual Studio 15 2017\" -A x64 -DCMAKE_INSTALL_PREFIX=\"./obs-studio-node\"",
+    "local:build": "cmake --build build --target install --config Debug",
+    "local:clean": "rm -rf build/*",
+    "test": "mocha --no-timeouts -r ts-node/register tests/osn-tests/src/**/*.ts"
   },
   "devDependencies": {
+    "@types/chai": "^4.1.7",
+    "@types/mocha": "^5.2.5",
+    "@types/node": "^11.9.5",
+    "chai": "^4.2.0",
+    "mocha": "^5.2.0",
     "nan": "2.10.0",
+    "request": "^2.88.0",
+    "rxjs": "^6.4.0",
+    "ts-node": "^7.0.1",
     "typedoc": "^0.11.1",
     "typedoc-default-themes": "^0.5.0",
     "typedoc-plugin-markdown": "^1.0.12",
-    "typescript": "^2.9.2"
+    "typescript": "^2.9.2",
+    "uuid": "^3.0.1"
   },
   "keywords": [
     "capture",

tests/osn-tests/osn/.gitignore

@@ -0,0 +1 @@
+/index.ts

tests/osn-tests/src/test_nodeobs_api.ts

@@ -1,6 +1,6 @@
 import 'mocha'
 import { expect } from 'chai'
-import * as osn from 'obs-studio-node';
+import * as osn from '../osn';
 import { OBSProcessHandler } from '../util/obs_process_handler';
 import { basicOBSInputTypes, showHideInputHotkeys, slideshowHotkeys, ffmpeg_sourceHotkeys, game_captureHotkeys, dshow_wasapitHotkeys } from '../util/general';
 

tests/osn-tests/src/test_nodeobs_autoconfig.ts

@@ -1,5 +1,5 @@
 import 'mocha';
-import * as osn from 'obs-studio-node';
+import * as osn from '../osn';
 import { OBSProcessHandler } from '../util/obs_process_handler';
 import { Services } from '../util/services';
 import { deleteConfigFiles } from '../util/general';
@@ -166,4 +166,4 @@ describe('nodeobs_autoconfig', () => {
             });            
         });
     });
-});
+});

tests/osn-tests/src/test_nodeobs_service.ts

@@ -1,6 +1,6 @@
 import 'mocha';
 import { expect } from 'chai';
-import * as osn from 'obs-studio-node';
+import * as osn from '../osn';
 import { OBSProcessHandler } from '../util/obs_process_handler';
 import { Subject } from 'rxjs';
 import { Services } from '../util/services';
@@ -416,4 +416,4 @@ describe('nodeobs_service', function() {
             }).to.not.throw();
         })
     });
-});
+});

tests/osn-tests/src/test_nodeobs_settings.ts

@@ -1,6 +1,6 @@
 import 'mocha'
 import { expect } from 'chai'
-import * as osn from 'obs-studio-node';
+import * as osn from '../osn';
 import { OBSProcessHandler } from '../util/obs_process_handler';
 import { deleteConfigFiles, basicOBSSettingsCategories } from '../util/general';
 
@@ -2662,4 +2662,4 @@ describe('nodeobs_settings', function() {
             expect(categories).to.include.members(basicOBSSettingsCategories);
         });
     });
-});
+});

tests/osn-tests/src/test_osn_fader.ts

@@ -1,7 +1,7 @@
 import 'mocha'
 import { expect } from 'chai'
 import { OBSProcessHandler } from '../util/obs_process_handler'
-import * as osn from 'obs-studio-node';
+import * as osn from '../osn';
 
 describe('osn_fader', () => {
     let obs: OBSProcessHandler;
@@ -127,4 +127,4 @@ describe('osn_fader', () => {
             });
         });
     });
-});
+});

tests/osn-tests/src/test_osn_filter.ts

@@ -1,7 +1,7 @@
 import 'mocha'
 import { expect } from 'chai'
-import * as osn from 'obs-studio-node';
-import { IFilter, ISettings } from 'obs-studio-node';
+import * as osn from '../osn';
+import { IFilter, ISettings } from '../osn';
 import { OBSProcessHandler } from '../util/obs_process_handler';
 import { basicOBSFilterTypes } from '../util/general';
 
@@ -67,4 +67,4 @@ describe('osn-filter', () => {
             });
         });
     });
-});
+});

tests/osn-tests/src/test_osn_global.ts

@@ -1,7 +1,7 @@
 import 'mocha'
 import { expect } from 'chai'
-import * as osn from 'obs-studio-node';
-import { IInput, ISource } from 'obs-studio-node';
+import * as osn from '../osn';
+import { IInput, ISource } from '../osn';
 import { OBSProcessHandler } from '../util/obs_process_handler';
 import { basicOBSInputTypes } from '../util/general';
 
@@ -128,4 +128,4 @@ describe('osn-global', () => {
             expect(locale).to.equal('pt-BR');
         });
     });
-});
+});

tests/osn-tests/src/test_osn_input.ts

@@ -1,7 +1,7 @@
 import 'mocha';
 import { expect } from 'chai';
-import * as osn from 'obs-studio-node';
-import { IInput, ISettings, ITimeSpec, IFilter } from 'obs-studio-node';
+import * as osn from '../osn';
+import { IInput, ISettings, ITimeSpec, IFilter } from '../osn';
 import { OBSProcessHandler } from '../util/obs_process_handler';
 import { basicOBSInputTypes, getTimeSpec } from '../util/general';
 
@@ -464,4 +464,4 @@ describe('osn-input', () => {
             input.release();
         });
     });
-});
+});

tests/osn-tests/src/test_osn_module.ts

@@ -1,6 +1,6 @@
 import 'mocha';
 import { expect } from 'chai';
-import * as osn from 'obs-studio-node';
+import * as osn from '../osn';
 import * as path from 'path';
 import * as fs from 'fs';
 import { OBSProcessHandler } from '../util/obs_process_handler';

tests/osn-tests/src/test_osn_scene.ts

@@ -1,7 +1,7 @@
 import 'mocha'
 import { expect } from 'chai'
-import * as osn from 'obs-studio-node';
-import { IScene, ISceneItem, IInput } from 'obs-studio-node';
+import * as osn from '../osn';
+import { IScene, ISceneItem, IInput } from '../osn';
 import { OBSProcessHandler } from '../util/obs_process_handler';
 import { basicOBSInputTypes } from '../util/general';
 

tests/osn-tests/src/test_osn_sceneitem.ts

@@ -1,7 +1,7 @@
 import 'mocha';
 import { expect } from 'chai';
-import { IInput } from 'obs-studio-node';
-import * as osn from 'obs-studio-node';
+import { IInput } from '../osn';
+import * as osn from '../osn';
 import { OBSProcessHandler } from '../util/obs_process_handler';
 
 interface IVec2 {
@@ -357,4 +357,4 @@ describe('osn-sceneitem', () => {
             sceneItem.remove();
         });
     });
-});
+});

tests/osn-tests/src/test_osn_source.ts

@@ -1,7 +1,7 @@
 import 'mocha';
 import { expect } from 'chai';
-import * as osn from 'obs-studio-node';
-import { ISettings } from 'obs-studio-node';
+import * as osn from '../osn';
+import { ISettings } from '../osn';
 import { OBSProcessHandler } from '../util/obs_process_handler';
 import { basicOBSInputTypes, basicOBSFilterTypes, basicOBSTransitionTypes } from '../util/general';
 
@@ -462,4 +462,4 @@ describe('osn-source', () => {
             });
         });
     });
-});
+});

tests/osn-tests/src/test_osn_transition.ts

@@ -1,7 +1,7 @@
 import 'mocha'
 import { expect } from 'chai'
-import * as osn from 'obs-studio-node';
-import { IScene, ITransition, ISettings, ISource } from 'obs-studio-node';
+import * as osn from '../osn';
+import { IScene, ITransition, ISettings, ISource } from '../osn';
 import { OBSProcessHandler } from '../util/obs_process_handler';
 import { basicOBSTransitionTypes } from '../util/general';
 
@@ -134,4 +134,4 @@ describe('osn-transition', () => {
             scene.release();         
         });
     });
-});
+});

tests/osn-tests/src/test_osn_video.ts

@@ -1,6 +1,6 @@
 import 'mocha';
 import { expect } from 'chai';
-import * as osn from 'obs-studio-node';
+import * as osn from '../osn';
 import { OBSProcessHandler } from '../util/obs_process_handler';
 
 describe('osn-video', () => {
@@ -43,4 +43,4 @@ describe('osn-video', () => {
             expect(totalFrames).to.equal(0);
         });
     });
-});
+});

tests/osn-tests/src/test_osn_volmeter.ts

@@ -1,6 +1,6 @@
 import 'mocha';
 import { expect } from 'chai';
-import * as osn from 'obs-studio-node';
+import * as osn from '../osn';
 import { OBSProcessHandler } from '../util/obs_process_handler';
 
 interface Dictionary<TItemType> {
@@ -98,4 +98,4 @@ describe('osn-volmeter', () => {
             input.release();
         });
     });
-});
+});

tests/osn-tests/util/general.ts

@@ -1,4 +1,4 @@
-import { ITimeSpec } from 'obs-studio-node';
+import { ITimeSpec } from '../osn';
 import { setOptions } from 'marked';
 
 const basicOBSInputTypes: string[] = ['image_source', 'color_source', 'slideshow', 'browser_source', 'ffmpeg_source', 'text_gdiplus', 'text_ft2_source', 

tests/osn-tests/util/obs_process_handler.ts

@@ -1,11 +1,11 @@
-import * as osn from 'obs-studio-node';
+import * as osn from '../osn';
 
 export class OBSProcessHandler {
     startup(): osn.EVideoCodes {
         const path = require('path');
         const uuid = require('uuid/v4');
 
-        const wd = path.join(path.normalize(__dirname), '..', 'node_modules', 'obs-studio-node');
+        const wd = path.normalize(osn.wd);
         const pipeName = 'osn-tests-pipe'.concat(uuid());  
 
         try {
@@ -27,4 +27,4 @@ export class OBSProcessHandler {
 
         return true;
     }
-}
+}

tsconfig.json

@@ -0,0 +1,15 @@
+{
+  "compilerOptions": {
+    "outDir": "../out",
+    "target": "es5",
+    "module": "commonjs",
+    "moduleResolution": "node",
+    "sourceMap": true,
+    "experimentalDecorators": true,
+    "lib": [ "es6", "es5" ],
+  },
+  "exclude": [
+    "node_modules"
+  ],
+  "compileOnSave": false
+}