feat: command line args via yargs, docs

- added --config and --validate command line flags via yargs. These will
  allow custom user configurations with a default behaviour of loading
  from the current working dir and/or default settings. --validate uses
  JSON Schema to validate the config.
- Remove old X.509 certificate and private key, which I assume was
  included previously to run git-proxy with TLS enabled via a demo. Can
  be re-added as needed but probably shouldn't be included in src (even
  if its for demo only).
- bumped Nodejs workflow to 16.x
- update docs to reflect new CLI args and additional details of running
  the app via npx
- update test to reflect new config file setting

.github/workflows/nodejs.yml

@@ -16,7 +16,7 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [13.x]
+        node-version: [16.x]
         mongodb-version: [4.4]
 
     steps:

README.md

@@ -48,13 +48,42 @@ Git Proxy is built with a developer-first mindset. By presenting simple-to-follo
 To install Git Proxy, use the [npm](https://www.npmjs.com/) package manager:
 
 ```bash
-$ npm install @finos/git-proxy
+$ npm install -g @finos/git-proxy
+$ git-proxy
 ```
 
 To install a specific version of Git Proxy, append the version to the end of the `install` command:
 
 ```bash
-$ npm install @finos/git-proxy@1.0.0
+$ npm install -g @finos/git-proxy@1.0.0
+```
+
+You can also run directly using `npx`:
+
+```bash
+$ npx @finos/git-proxy
+```
+
+## Configuration
+By default, git-proxy ships with a [default configuration](./proxy.config.json) for demonstration purposes. In most environments, this should be overridden by your user-specific values.
+
+To set your own values, create a `proxy.config.json` in the current working directory. This will be loaded when you execute `git-proxy` if present.
+
+If you wish to specify a different file location to use as configuration, use the `-c/--config` command-line argument:
+
+```bash
+$ git-proxy --config /etc/gitproxy/config.json
+# With npx
+$ npx -- git-proxy --config /etc/gitproxy/config.json 
+```
+
+### Validation
+To valid your configuration against the [included schema](config.schema.json), use the following included script:
+
+```bash
+$ git-proxy --validate
+# Check a custom file location
+$ git-proxy --validate --config /etc/gitproxy/config.json
 ```
 
 ## Contributing

config.schema.json

@@ -0,0 +1,79 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://git-proxy.finos.org/config.schema.json",
+  "title": "Git Proxy",
+  "description": "Configuration file for modifying the behaviour of git-proxy",
+  "type": "object",
+  "properties": {
+    "authorisedList": {
+      "description": "List of repositories that are authorised to be pushed to through the proxy.",
+      "type": "array",
+      "items": {
+        "$ref": "#/$defs/authorisedRepo"
+      }
+    },
+    "sink": {
+      "description": "List of database sources. The first source in the configuration with enabled=true will be used.",
+      "type": "array",
+      "items": {
+        "$ref": "#/$defs/database"
+      }
+    },
+    "authentication": {
+      "description": "List of authentication sources. The first source in the configuration with enabled=true will be used.",
+      "type": "array",
+      "items": {
+        "$ref": "#/$defs/authentication"
+      }
+    },
+    "tempPassword": {
+      "description": "Toggle the generation of temporary password for git-proxy admin user",
+      "type": "object",
+      "properties": {
+        "sendEmail": { "type": "boolean" },
+        "emailConfig": {
+          "description": "Generic object to configure nodemailer. For full type information, please see https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/nodemailer",
+          "type": "object"
+        }
+      }
+    }
+  },
+  "additionalProperties": false,
+  "anyOf": [
+    { "required": "authorisedList" },
+    { "required": "sink" },
+    { "required": "authentication" },
+    { "required": "tempPassword" }
+  ],
+  "$defs": {
+    "authorisedRepo": {
+      "type": "object",
+      "properties": {
+        "project": { "type": "string" },
+        "name": { "type": "string" },
+        "url": { "type": "string" }
+      },
+      "required": [ "project", "name", "url" ]
+    },
+    "database": {
+      "type": "object",
+      "properties": {
+        "type": { "type": "string" },
+        "enabled": { "type": "boolean" },
+        "connectionString": { "type": "string" },
+        "options": { "type": "object" },
+        "params": { "type": "object" }
+      },
+      "required": [ "type", "enabled" ]
+    },
+    "authentication": {
+      "type": "object",
+      "properties": {
+        "type": { "type": "string" },
+        "enabled": { "type": "boolean" },
+        "options": { "type": "object" }
+      },
+      "required": [ "type", "enabled" ]
+    }
+  }
+}

index.js

@@ -1,4 +1,43 @@
 #!/usr/bin/env node
+/* eslint-disable max-len */
+const argv = require('yargs/yargs')(process.argv.slice(2))
+  .usage('Usage: $0 [options]')
+  .options({
+    validate: {
+      description:
+        'Check the proxy.config.json file in the current working directory for validation errors.',
+      required: false,
+      alias: 'v',
+    },
+    config: {
+      description: 'Path to custom git-proxy configuration file.',
+      default: 'proxy.config.json',
+      required: false,
+      alias: 'c',
+    },
+  }).argv;
+
+require('./src/config/file').configFile = argv.c ? argv.c : undefined;
+
+if (argv.v) {
+  const fs = require('fs');
+  const path = require('path');
+  const validate = require('jsonschema').validate;
+  const configFile = require('./src/config/file').configFile;
+
+  const config = JSON.parse(
+    fs.readFileSync(path.join(process.cwd(), configFile)),
+  );
+  const schema = JSON.parse(
+    fs.readFileSync(path.join(__dirname, 'config.schema.json')),
+  );
+
+  validate(config, schema, { required: true, throwError: true });
+
+  console.log(`${configFile} is valid`);
+  process.exit(0);
+}
+
 const proxy = require('./src/proxy');
 const service = require('./src/service');
 

package.json

@@ -37,6 +37,7 @@
     "express-session": "^1.17.1",
     "generate-password": "^1.5.1",
     "history": "5.3.0",
+    "jsonschema": "^1.4.1",
     "lodash": "^4.17.21",
     "moment": "^2.29.4",
     "mongodb": "^5.0.0",
@@ -51,7 +52,8 @@
     "react-dom": "^16.13.1",
     "react-html-parser": "^2.0.2",
     "react-router-dom": "6.16.0",
-    "uuid": "^9.0.0"
+    "uuid": "^9.0.0",
+    "yargs": "^17.7.2"
   },
   "devDependencies": {
     "@babel/eslint-parser": "^7.22.9",

src/config/file.js

@@ -0,0 +1,14 @@
+const path = require('path');
+// eslint-disable-next-line prefer-const
+let configFile = undefined;
+
+module.exports = {
+  get configFile() {
+    return configFile
+      ? configFile
+      : path.join(process.cwd(), 'proxy.config.json');
+  },
+  set configFile(file) {
+    configFile = file;
+  },
+};

src/config/index.js

@@ -1,8 +1,7 @@
 const fs = require('fs');
-const path = require('path');
 
-const defaultSettings = require('../../resources/config.json');
-const userSettingsPath = path.join(process.cwd(), './user-settings.json');
+const defaultSettings = require('../../proxy.config.json');
+const userSettingsPath = require('./file').configFile;
 
 let _userSettings = null;
 if (fs.existsSync(userSettingsPath)) {

test/testConfig.js

@@ -2,7 +2,7 @@
 const chai = require('chai');
 const fs = require('fs');
 const path = require('path');
-const defaultSettings = require('../resources/config.json');
+const defaultSettings = require('../proxy.config.json');
 
 chai.should();
 const expect = chai.expect;
@@ -30,13 +30,11 @@ describe('default configuration', function () {
 describe('user configuration', function () {
   let tempDir;
   let tempUserFile;
-  let curDirUserFile;
 
   beforeEach(function () {
     tempDir = fs.mkdtempSync('gitproxy-test');
-    tempUserFile = path.join(tempDir, 'user-settings.json');
-    curDirUserFile = path.join(process.cwd(), 'user-settings.json');
-    fs.symlinkSync(tempUserFile, curDirUserFile);
+    tempUserFile = path.join(tempDir, 'test-settings.json');
+    require('../src/config/file').configFile = tempUserFile;
   });
 
   it('should override default settings for authorisedList', function () {
@@ -110,7 +108,6 @@ describe('user configuration', function () {
   });
 
   afterEach(function () {
-    fs.unlinkSync(curDirUserFile);
     fs.rmSync(tempUserFile);
     fs.rmdirSync(tempDir);
     delete require.cache[require.resolve('../src/config')];

user-settings.json

@@ -0,0 +1 @@
+{ "authorisedList": [ { "project": "foo", "name": "bar", "url": "https://github.com/foo/bar.git" } ] }