@achs/env 3.0.0 → 3.1.0

package/tests/env/env.schema.json

@@ -0,0 +1,225 @@
+{
+    "package-json": {
+        "type": "object",
+        "properties": {
+            "ENV": {
+                "type": [
+                    "string"
+                ],
+                "nullable": true
+            },
+            "VERSION": {
+                "type": [
+                    "string"
+                ],
+                "nullable": true
+            },
+            "PROJECT": {
+                "type": [
+                    "string"
+                ],
+                "nullable": true
+            },
+            "NAME": {
+                "type": [
+                    "string"
+                ],
+                "nullable": true
+            },
+            "TITLE": {
+                "type": [
+                    "string"
+                ],
+                "nullable": true
+            },
+            "DESCRIPTION": {
+                "type": [
+                    "string"
+                ],
+                "nullable": true
+            }
+        }
+    },
+    "app-settings": {
+        "type": "object",
+        "properties": {
+            "VAR1": {
+                "type": [
+                    "string"
+                ],
+                "nullable": true
+            },
+            "C1": {
+                "type": [
+                    "string"
+                ],
+                "nullable": true
+            },
+            "C2": {
+                "type": [
+                    "string"
+                ],
+                "nullable": true
+            },
+            "C3": {
+                "type": [
+                    "integer"
+                ],
+                "nullable": true
+            },
+            "GROUP1": {
+                "type": [
+                    "object"
+                ],
+                "properties": {
+                    "VAR1": {
+                        "type": [
+                            "null"
+                        ],
+                        "nullable": true
+                    },
+                    "VAR2": {
+                        "type": [
+                            "string"
+                        ],
+                        "nullable": true
+                    },
+                    "VAR3": {
+                        "type": [
+                            "boolean"
+                        ],
+                        "nullable": true
+                    },
+                    "GROUP2": {
+                        "type": [
+                            "object"
+                        ],
+                        "properties": {
+                            "VAR1": {
+                                "type": [
+                                    "string"
+                                ],
+                                "nullable": true
+                            }
+                        },
+                        "nullable": true
+                    }
+                },
+                "nullable": true
+            },
+            "C4": {
+                "type": [
+                    "string"
+                ],
+                "format": "utc-millisec",
+                "nullable": true
+            },
+            "NODE_ENV": {
+                "type": [
+                    "string"
+                ],
+                "nullable": true
+            }
+        }
+    },
+    "azure-key-vault": {
+        "type": "object",
+        "properties": {
+            "VAR1": {
+                "type": [
+                    "boolean"
+                ],
+                "nullable": true
+            },
+            "VAR2": {
+                "type": [
+                    "boolean"
+                ],
+                "nullable": true
+            },
+            "VAR3": {
+                "type": [
+                    "integer"
+                ],
+                "nullable": true
+            },
+            "VAR4": {
+                "type": [
+                    "string"
+                ],
+                "nullable": true
+            },
+            "ARR1": {
+                "type": [
+                    "array"
+                ],
+                "nullable": true
+            },
+            "GROUP2": {
+                "type": [
+                    "object"
+                ],
+                "properties": {
+                    "VAR1": {
+                        "type": [
+                            "string"
+                        ],
+                        "nullable": true
+                    },
+                    "VAR2": {
+                        "type": [
+                            "string"
+                        ],
+                        "nullable": true
+                    }
+                },
+                "nullable": true
+            },
+            "$SECRET": {
+                "type": [
+                    "string"
+                ],
+                "nullable": true
+            }
+        }
+    },
+    "local": {
+        "type": "object",
+        "properties": {
+            "VAR4": {
+                "type": [
+                    "string"
+                ],
+                "nullable": true
+            },
+            "GROUP1": {
+                "type": [
+                    "object"
+                ],
+                "properties": {
+                    "VAR1": {
+                        "type": [
+                            "null"
+                        ],
+                        "nullable": true
+                    }
+                },
+                "nullable": true
+            },
+            "GROUP2": {
+                "type": [
+                    "object"
+                ],
+                "properties": {
+                    "VAR2": {
+                        "type": [
+                            "string"
+                        ],
+                        "nullable": true
+                    }
+                },
+                "nullable": true
+            }
+        }
+    }
+}

package/tests/env/keys.json

@@ -0,0 +1,7 @@
+{
+    "dev": {
+        "clientId": "96ae96c9-16e0-464e-a348-4c688b56ca31",
+        "clientSecret": "UTWuJsx3awfJ6RA5jaDsXWurqDr2yaEj",
+        "tenantId": "26df232c-d473-4615-9e8f-d2397aeed3ba"
+    }
+}

package/tests/env/settings/schema.json

@@ -0,0 +1,239 @@
+{
+    "package-json": {
+        "type": "object",
+        "properties": {
+            "ENV": {
+                "type": [
+                    "string"
+                ],
+                "nullable": true
+            },
+            "VERSION": {
+                "type": [
+                    "string"
+                ],
+                "nullable": true
+            },
+            "PROJECT": {
+                "type": [
+                    "string"
+                ],
+                "nullable": true
+            },
+            "NAME": {
+                "type": [
+                    "string"
+                ],
+                "nullable": true
+            },
+            "TITLE": {
+                "type": [
+                    "string"
+                ],
+                "nullable": true
+            },
+            "DESCRIPTION": {
+                "type": [
+                    "string"
+                ],
+                "nullable": true
+            }
+        }
+    },
+    "app-settings": {
+        "type": "object",
+        "properties": {
+            "VAR1": {
+                "type": [
+                    "string"
+                ],
+                "nullable": true
+            },
+            "C1": {
+                "type": [
+                    "string"
+                ],
+                "nullable": true
+            },
+            "C2": {
+                "type": [
+                    "string"
+                ],
+                "nullable": true
+            },
+            "C3": {
+                "type": [
+                    "integer"
+                ],
+                "nullable": true
+            },
+            "GROUP1": {
+                "type": [
+                    "object"
+                ],
+                "properties": {
+                    "VAR1": {
+                        "type": [
+                            "null"
+                        ],
+                        "nullable": true
+                    },
+                    "VAR2": {
+                        "type": [
+                            "string"
+                        ],
+                        "nullable": true
+                    },
+                    "VAR3": {
+                        "type": [
+                            "boolean"
+                        ],
+                        "nullable": true
+                    },
+                    "GROUP2": {
+                        "type": [
+                            "object"
+                        ],
+                        "properties": {
+                            "VAR1": {
+                                "type": [
+                                    "string"
+                                ],
+                                "nullable": true
+                            }
+                        },
+                        "nullable": true
+                    }
+                },
+                "nullable": true
+            },
+            "C4": {
+                "type": [
+                    "string"
+                ],
+                "format": "utc-millisec",
+                "nullable": true
+            },
+            "NODE_ENV": {
+                "type": [
+                    "string"
+                ],
+                "nullable": true
+            }
+        }
+    },
+    "azure-key-vault": {
+        "type": "object",
+        "properties": {
+            "VAR1": {
+                "type": [
+                    "boolean"
+                ],
+                "nullable": true
+            },
+            "VAR2": {
+                "type": [
+                    "boolean"
+                ],
+                "nullable": true
+            },
+            "VAR3": {
+                "type": [
+                    "integer"
+                ],
+                "nullable": true
+            },
+            "VAR4": {
+                "type": [
+                    "string"
+                ],
+                "nullable": true
+            },
+            "ARR1": {
+                "type": [
+                    "array"
+                ],
+                "nullable": true
+            },
+            "GROUP2": {
+                "type": [
+                    "object"
+                ],
+                "properties": {
+                    "VAR1": {
+                        "type": [
+                            "string"
+                        ],
+                        "nullable": true
+                    },
+                    "VAR2": {
+                        "type": [
+                            "string"
+                        ],
+                        "nullable": true
+                    }
+                },
+                "nullable": true
+            },
+            "$SECRET": {
+                "type": [
+                    "string"
+                ],
+                "nullable": true
+            },
+            "GROUP1": {
+                "type": [
+                    "object"
+                ],
+                "properties": {
+                    "VAR1": {
+                        "type": [
+                            "null"
+                        ],
+                        "nullable": true
+                    }
+                },
+                "nullable": true
+            }
+        }
+    },
+    "local": {
+        "type": "object",
+        "properties": {
+            "VAR4": {
+                "type": [
+                    "string"
+                ],
+                "nullable": true
+            },
+            "GROUP1": {
+                "type": [
+                    "object"
+                ],
+                "properties": {
+                    "VAR1": {
+                        "type": [
+                            "null"
+                        ],
+                        "nullable": true
+                    }
+                },
+                "nullable": true
+            },
+            "GROUP2": {
+                "type": [
+                    "object"
+                ],
+                "properties": {
+                    "VAR2": {
+                        "type": [
+                            "string"
+                        ],
+                        "nullable": true
+                    }
+                },
+                "nullable": true
+            }
+        }
+    }
+}

package/tests/env/settings/settings.json

@@ -0,0 +1,22 @@
+{
+    "logMaskValuesOfKeys": ["SECRET"],
+    "providers": [
+        {
+            "path": "package-json"
+        },
+        {
+            "path": "app-settings"
+        },
+        {
+            "path": "azure-key-vault",
+            "config": {
+                "dev": {
+                    "vaultUrl": "https://azure.vault.net"
+                }
+            }
+        },
+        {
+            "path": "local"
+        }
+    ]
+}

package/tests/env.int.test.ts

@@ -0,0 +1,42 @@
+import { execEnv, execDebugEnv } from './exec';
+
+const subcmd = ': node tests/run.js';
+
+describe('env command', () => {
+    test('show helps', () => {
+        const response = execEnv('--help');
+
+        expect(response).toMatch(/usage: env/i);
+    });
+
+    test('load env into run.js', () => {
+        const response = execEnv('-e dev', '--m debug', subcmd);
+
+        expect(response).not.toMatch(/error/i);
+    });
+
+    test('load env without modes into run.js', () => {
+        const response = execEnv('-e dev', ': node tests/run.js');
+
+        expect(response).not.toMatch(/error/i);
+    });
+
+    test('load env with two modes into run.js', () => {
+        const response = execEnv('-e dev', '--m debug build', subcmd);
+
+        expect(response).not.toMatch(/error/i);
+    });
+
+    test('load env with options after subcmd', () => {
+        const response = execEnv('-e dev', subcmd, ': -m debug');
+
+        expect(response).not.toMatch(/error/i);
+    });
+
+    test('logger must not show SECRET variable value', () => {
+        const response = execDebugEnv('-e dev', subcmd);
+
+        expect(response).not.toMatch(/error/i);
+        expect(response).not.toMatch(/any secret/i);
+    });
+});

package/tests/exec.ts

@@ -0,0 +1,19 @@
+import { execSync } from 'child_process';
+
+const CMD = 'node dist/main.js';
+
+const BASE_ARGS = ['--root tests/env', '--mock'];
+
+export const execEnv = (...args: string[]): string | undefined => {
+    return execSync(
+        `${CMD} ${[...BASE_ARGS, '--log error', ...args].join(' ')}`
+    )?.toString();
+};
+
+export const execDebugEnv = (...args: string[]): string | undefined => {
+    return execSync(
+        `${CMD} ${[...BASE_ARGS, '--log debug', ...args].join(' ')}`
+    )?.toString();
+};
+
+export { execSync as exec } from 'child_process';

package/tests/export.int.test.ts

@@ -0,0 +1,9 @@
+import { execEnv } from './exec';
+
+describe('export commands', () => {
+    test('export', () => {
+        const response = execEnv('export', '-e dev', '-m debug');
+
+        expect(response).not.toMatch(/error/i);
+    });
+});

package/tests/pull-push.int.test.ts

@@ -0,0 +1,15 @@
+import { execEnv } from './exec';
+
+describe('pull & push commands', () => {
+    test('pull', () => {
+        const response = execEnv('pull', '-e dev');
+
+        expect(response).not.toMatch(/error/i);
+    });
+
+    test('push', () => {
+        const response = execEnv('push', '-e dev');
+
+        expect(response).not.toMatch(/error/i);
+    });
+});

package/tests/run.js

@@ -0,0 +1,32 @@
+function validateEnv(...vars) {
+    for(const key of vars) {
+        if(!process.env[key])
+        {
+            throw new Error(`${key} dont loaded`);
+        }
+    }
+}
+
+validateEnv(
+    'NODE_ENV',
+    'ENV',
+    'VERSION',
+    'PROJECT',
+    'NAME',
+    'TITLE',
+    'DESCRIPTION',
+    'VAR1',
+    'C1',
+    'C2',
+    'C3',
+    'C4',
+    'GROUP1__VAR2',
+    'GROUP1__VAR3',
+    'GROUP1__GROUP2__VAR1',
+    'VAR2',
+    'VAR3',
+    'VAR4',
+    'ARR1',
+    'GROUP2__VAR1',
+    'GROUP2__VAR2'
+);

package/tests/schema.int.test.ts

@@ -0,0 +1,9 @@
+import { execEnv } from './exec';
+
+describe('schema command', () => {
+    test('schema', () => {
+        const response = execEnv('schema', '-e dev', '-m debug');
+
+        expect(response).not.toMatch(/error/i);
+    });
+});

package/tests/setup.ts

@@ -0,0 +1,13 @@
+import { exec, execEnv } from './exec';
+
+/**
+ * Builds app and regenerates schema.
+ */
+function setup(): void {
+    // builds application
+    exec('npm run build');
+    // generates schema from environment variables
+    execEnv('schema', '-e dev', '-m debug');
+}
+
+export default setup;

package/tsconfig.build.json

@@ -0,0 +1,10 @@
+{
+    "extends": "./tsconfig.json",
+    "exclude": [
+        "tests/**/*",
+        "**/*.spec.ts",
+        "**/*.test.ts",
+        "**/__tests__",
+        "**/__mocks__"
+    ]
+}

package/tsconfig.json

@@ -0,0 +1,37 @@
+{
+    "compilerOptions": {
+        "baseUrl": "src",
+        "outDir": "dist",
+
+        "target": "es2018",
+        "module": "commonjs",
+        "moduleResolution": "node",
+        "resolveJsonModule": true,
+
+        "allowJs": false,
+        "checkJs": false,
+
+        "experimentalDecorators": true,
+        "emitDecoratorMetadata": true,
+
+        "incremental": true,
+        "sourceMap": true,
+        "declaration": true,
+        "declarationMap": true,
+        "removeComments": true,
+
+        "isolatedModules": true,
+        "esModuleInterop": true,
+        "importHelpers": false,
+        "skipLibCheck": false,
+        "downlevelIteration": false,
+
+        "strict": true,
+        "strictPropertyInitialization": false,
+        "noFallthroughCasesInSwitch": false,
+        "noUnusedLocals": false,
+        "noUnusedParameters": false,
+        "exactOptionalPropertyTypes": false
+    },
+    "include": ["src/**/*", "tests/**/*", "**/*.spec.ts", "**/*.test.ts"]
+}