Skip to content

Commit 1071941

Browse files
nhooyrnhooyr
committed
plugin: Add basic loading test
Will work on testing overlay next.
1 parent 8ae555e commit 1071941

File tree

7 files changed

+580
-0
lines changed

7 files changed

+580
-0
lines changed

‎test/plugin.test.ts

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
import { describe } from "mocha"
2+
import { PluginAPI } from "../src/node/plugin"
3+
import { logger } from "@coder/logger"
4+
import * as path from "path"
5+
import * as assert from "assert"
6+
7+
/**
8+
* Use $LOG_LEVEL=debug to see debug logs.
9+
*/
10+
describe("plugin", () => {
11+
it("loads", async () => {
12+
const papi = new PluginAPI(logger, path.resolve(__dirname, "test-plugin") + ":meow")
13+
await papi.loadPlugins()
14+
15+
// We remove the function fields from the application's plugins.
16+
const apps = JSON.parse(JSON.stringify(await papi.applications()))
17+
18+
assert.deepEqual([
19+
{
20+
name: "goland",
21+
version: "4.0.0",
22+
iconPath: "icon.svg",
23+
plugin: {
24+
name: "test-plugin",
25+
version: "1.0.0",
26+
description: "Fake plugin for testing code-server's plugin API",
27+
},
28+
},
29+
], apps)
30+
})
31+
})

‎test/test-plugin/.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
out

‎test/test-plugin/package.json

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
{
2+
"private": true,
3+
"name": "test-plugin",
4+
"version": "1.0.0",
5+
"description": "Fake plugin for testing code-server's plugin API",
6+
"engines": {
7+
"code-server": "^3.6.0"
8+
},
9+
"main": "out/index.js",
10+
"devDependencies": {
11+
"@types/express": "^4.17.8",
12+
"typescript": "^4.0.5"
13+
},
14+
"scripts": {
15+
"build": "tsc"
16+
},
17+
"dependencies": {
18+
"express": "^4.17.1"
19+
}
20+
}

‎test/test-plugin/public/icon.svg

Lines changed: 1 addition & 0 deletions
Loading

‎test/test-plugin/src/index.ts

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
import * as pluginapi from "../../../typings/plugin"
2+
import * as express from "express"
3+
import * as path from "path";
4+
5+
export function init(config: pluginapi.PluginConfig) {
6+
config.logger.debug("test-plugin loaded!")
7+
}
8+
9+
export function router(): express.Router {
10+
const r = express.Router()
11+
r.get("/goland/icon.svg", (req, res) => {
12+
res.sendFile(path.resolve(__dirname, "../public/icon.svg"))
13+
})
14+
return r
15+
}
16+
17+
export function applications(): pluginapi.Application[] {
18+
return [{
19+
name: "goland",
20+
version: "4.0.0",
21+
iconPath: "icon.svg",
22+
}]
23+
}

‎test/test-plugin/tsconfig.json

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
{
2+
"compilerOptions": {
3+
/* Visit https://aka.ms/tsconfig.json to read more about this file */
4+
5+
/* Basic Options */
6+
// "incremental": true, /* Enable incremental compilation */
7+
"target": "es5", /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', or 'ESNEXT'. */
8+
"module": "commonjs", /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', 'es2020', or 'ESNext'. */
9+
// "lib": [], /* Specify library files to be included in the compilation. */
10+
// "allowJs": true, /* Allow javascript files to be compiled. */
11+
// "checkJs": true, /* Report errors in .js files. */
12+
// "jsx": "preserve", /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
13+
// "declaration": true, /* Generates corresponding '.d.ts' file. */
14+
// "declarationMap": true, /* Generates a sourcemap for each corresponding '.d.ts' file. */
15+
// "sourceMap": true, /* Generates corresponding '.map' file. */
16+
// "outFile": "./", /* Concatenate and emit output to single file. */
17+
"outDir": "./out", /* Redirect output structure to the directory. */
18+
// "rootDir": "./", /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
19+
// "composite": true, /* Enable project compilation */
20+
// "tsBuildInfoFile": "./", /* Specify file to store incremental compilation information */
21+
// "removeComments": true, /* Do not emit comments to output. */
22+
// "noEmit": true, /* Do not emit outputs. */
23+
// "importHelpers": true, /* Import emit helpers from 'tslib'. */
24+
// "downlevelIteration": true, /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
25+
// "isolatedModules": true, /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
26+
27+
/* Strict Type-Checking Options */
28+
"strict": true, /* Enable all strict type-checking options. */
29+
// "noImplicitAny": true, /* Raise error on expressions and declarations with an implied 'any' type. */
30+
// "strictNullChecks": true, /* Enable strict null checks. */
31+
// "strictFunctionTypes": true, /* Enable strict checking of function types. */
32+
// "strictBindCallApply": true, /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
33+
// "strictPropertyInitialization": true, /* Enable strict checking of property initialization in classes. */
34+
// "noImplicitThis": true, /* Raise error on 'this' expressions with an implied 'any' type. */
35+
// "alwaysStrict": true, /* Parse in strict mode and emit "use strict" for each source file. */
36+
37+
/* Additional Checks */
38+
// "noUnusedLocals": true, /* Report errors on unused locals. */
39+
// "noUnusedParameters": true, /* Report errors on unused parameters. */
40+
// "noImplicitReturns": true, /* Report error when not all code paths in function return a value. */
41+
// "noFallthroughCasesInSwitch": true, /* Report errors for fallthrough cases in switch statement. */
42+
43+
/* Module Resolution Options */
44+
// "moduleResolution": "node", /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
45+
// "baseUrl": "./", /* Base directory to resolve non-absolute module names. */
46+
// "paths": {}, /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
47+
// "rootDirs": [], /* List of root folders whose combined content represents the structure of the project at runtime. */
48+
// "typeRoots": [], /* List of folders to include type definitions from. */
49+
// "types": [], /* Type declaration files to be included in compilation. */
50+
// "allowSyntheticDefaultImports": true, /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
51+
"esModuleInterop": true, /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
52+
// "preserveSymlinks": true, /* Do not resolve the real path of symlinks. */
53+
// "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */
54+
55+
/* Source Map Options */
56+
// "sourceRoot": "", /* Specify the location where debugger should locate TypeScript files instead of source locations. */
57+
// "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */
58+
// "inlineSourceMap": true, /* Emit a single file with source maps instead of having a separate file. */
59+
// "inlineSources": true, /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
60+
61+
/* Experimental Options */
62+
// "experimentalDecorators": true, /* Enables experimental support for ES7 decorators. */
63+
// "emitDecoratorMetadata": true, /* Enables experimental support for emitting type metadata for decorators. */
64+
65+
/* Advanced Options */
66+
"skipLibCheck": true, /* Skip type checking of declaration files. */
67+
"forceConsistentCasingInFileNames": true /* Disallow inconsistently-cased references to the same file. */
68+
}
69+
}

0 commit comments

Comments
 (0)