neonctl 1.18.0 → 1.18.1

package/auth.js

@@ -40,7 +40,7 @@ export const auth = async ({ oauthHost, clientId }) => {
     //
     const server = createServer();
     server.listen(0, '127.0.0.1', function () {
-        log.info(`Listening on port ${this.address().port}`);
+        log.debug(`Listening on port ${this.address().port}`);
     });
     await new Promise((resolve) => server.once('listening', resolve));
     const listen_port = server.address().port;

package/commands/auth.js

@@ -13,13 +13,10 @@ export const builder = (yargs) => yargs;
 export const handler = async (args) => {
     await authFlow(args);
 };
-export const authFlow = async ({ configDir, oauthHost, clientId, }) => {
-    if (isCi()) {
+export const authFlow = async ({ configDir, oauthHost, clientId, forceAuth, }) => {
+    if (!forceAuth && isCi()) {
         throw new Error('Cannot run interactive auth in CI');
     }
-    if (!clientId) {
-        throw new Error('Missing client id');
-    }
     const tokenSet = await auth({
         oauthHost: oauthHost,
         clientId: clientId,

package/commands/auth.test.js

@@ -0,0 +1,37 @@
+import axios from 'axios';
+import { beforeAll, describe, test, jest, afterAll, expect, } from '@jest/globals';
+import { mkdtempSync, rmSync, readFileSync } from 'node:fs';
+import { startOauthServer } from '../test_utils/oauth_server';
+jest.unstable_mockModule('open', () => ({
+    __esModule: true,
+    default: jest.fn((url) => {
+        axios.get(url);
+    }),
+}));
+// "open" module should be imported after mocking
+const authModule = await import('./auth');
+describe('auth', () => {
+    let configDir = '';
+    let server;
+    beforeAll(async () => {
+        configDir = mkdtempSync('test-config');
+        server = await startOauthServer();
+    });
+    afterAll(() => {
+        rmSync(configDir, { recursive: true });
+        server.stop();
+    });
+    test('should auth', async () => {
+        await authModule.authFlow({
+            _: ['auth'],
+            apiHost: 'http://localhost:1111',
+            clientId: 'test-client-id',
+            configDir,
+            forceAuth: true,
+            oauthHost: 'http://localhost:7777',
+        });
+        const credentials = JSON.parse(readFileSync(`${configDir}/credentials.json`, 'utf-8'));
+        expect(credentials.access_token).toEqual(expect.any(String));
+        expect(credentials.refresh_token).toEqual(expect.any(String));
+    });
+});

package/commands/branches.test.js

@@ -1,5 +1,5 @@
 import { describe } from '@jest/globals';
-import { testCliCommand } from '../test_utils.js';
+import { testCliCommand } from '../test_utils/test_cli_command.js';
 describe('branches', () => {
     testCliCommand({
         name: 'list',

package/commands/connection_string.test.js

@@ -1,5 +1,5 @@
 import { describe } from '@jest/globals';
-import { testCliCommand } from '../test_utils';
+import { testCliCommand } from '../test_utils/test_cli_command';
 describe('connection_string', () => {
     testCliCommand({
         name: 'connection_string',

package/commands/databases.test.js

@@ -1,5 +1,5 @@
 import { describe } from '@jest/globals';
-import { testCliCommand } from '../test_utils.js';
+import { testCliCommand } from '../test_utils/test_cli_command.js';
 describe('databases', () => {
     testCliCommand({
         name: 'list',

package/commands/help.test.js

@@ -1,5 +1,5 @@
 import { describe, expect } from '@jest/globals';
-import { testCliCommand } from '../test_utils.js';
+import { testCliCommand } from '../test_utils/test_cli_command.js';
 describe('help', () => {
     testCliCommand({
         name: 'without args',

package/commands/operations.test.js

@@ -1,5 +1,5 @@
 import { describe } from '@jest/globals';
-import { testCliCommand } from '../test_utils.js';
+import { testCliCommand } from '../test_utils/test_cli_command.js';
 describe('operations', () => {
     testCliCommand({
         name: 'list',

package/commands/projects.test.js

@@ -1,5 +1,5 @@
 import { describe } from '@jest/globals';
-import { testCliCommand } from '../test_utils.js';
+import { testCliCommand } from '../test_utils/test_cli_command.js';
 describe('projects', () => {
     testCliCommand({
         name: 'list',

package/commands/roles.test.js

@@ -1,5 +1,5 @@
 import { describe } from '@jest/globals';
-import { testCliCommand } from '../test_utils.js';
+import { testCliCommand } from '../test_utils/test_cli_command.js';
 describe('roles', () => {
     testCliCommand({
         name: 'list',

package/config.js

@@ -3,8 +3,8 @@ import { homedir } from 'node:os';
 import { existsSync, mkdirSync } from 'node:fs';
 import { isCi } from './env.js';
 export const defaultDir = join(process.env.XDG_CONFIG_HOME || join(homedir(), '.config'), 'neonctl');
-export const ensureConfigDir = async ({ 'config-dir': configDir, }) => {
-    if (!existsSync(configDir) && !isCi()) {
+export const ensureConfigDir = async ({ 'config-dir': configDir, 'force-auth': forceAuth, }) => {
+    if (!existsSync(configDir) && (!isCi() || forceAuth)) {
         mkdirSync(configDir, { recursive: true });
     }
 };

package/index.js

@@ -1,3 +1,4 @@
+import { basename } from 'node:path';
 import yargs from 'yargs';
 import { hideBin } from 'yargs/helpers';
 import axiosDebug from 'axios-debug-log';
@@ -46,6 +47,12 @@ builder = builder
     group: 'Global options:',
     type: 'string',
     default: defaultDir,
+})
+    .option('force-auth', {
+    describe: 'Force authentication',
+    type: 'boolean',
+    hidden: true,
+    default: false,
 })
     .middleware(ensureConfigDir)
     // Auth flow
@@ -87,6 +94,7 @@ builder = builder
     .group('help', 'Global options:')
     .alias('help', 'h')
     .completion()
+    .scriptName(basename(process.argv[1]) === 'neon' ? 'neon' : 'neonctl')
     .fail(async (msg, err) => {
     if (isAxiosError(err)) {
         if (err.code === 'ECONNABORTED') {

package/package.json

@@ -5,7 +5,7 @@
     "url": "git@github.com:neondatabase/neonctl.git"
   },
   "type": "module",
-  "version": "1.18.0",
+  "version": "1.18.1",
   "description": "CLI tool for NeonDB Cloud management",
   "main": "index.js",
   "author": "NeonDB",
@@ -41,6 +41,7 @@
     "husky": "^8.0.3",
     "jest": "^29.5.0",
     "lint-staged": "^13.0.3",
+    "oauth2-mock-server": "^6.0.0",
     "pkg": "^5.8.1",
     "prettier": "^2.7.1",
     "rollup": "^3.26.2",
@@ -84,7 +85,7 @@
     "lint": "tsc --noEmit && eslint src --ext .ts",
     "build": "npm run generateParams && npm run clean && tsc && cp src/*.html package*.json README.md ./dist",
     "clean": "rm -rf dist",
-    "generateParams": "ts-node --esm generateOptionsFromSpec.ts",
+    "generateParams": "node --loader ts-node/esm ./generateOptionsFromSpec.ts",
     "start": "node src/index.js",
     "test": "node --experimental-vm-modules node_modules/.bin/jest"
   },

package/test_utils/mock_server.js

@@ -0,0 +1,14 @@
+import emocks from 'emocks';
+import express from 'express';
+import { join } from 'node:path';
+import { log } from '../log';
+export const runMockServer = async (mockDir) => new Promise((resolve) => {
+    const app = express();
+    app.use(express.json());
+    app.use('/', emocks(join(process.cwd(), 'mocks', mockDir)));
+    const server = app.listen(0);
+    server.on('listening', () => {
+        log.info('Mock server listening at %d', server.address().port);
+    });
+    resolve(server);
+});

package/test_utils/oauth_server.js

@@ -0,0 +1,9 @@
+import { log } from '../log';
+import { OAuth2Server } from 'oauth2-mock-server';
+export const startOauthServer = async () => {
+    const server = new OAuth2Server();
+    await server.issuer.keys.generate('RS256');
+    await server.start(7777, 'localhost');
+    log.info('Started OAuth server');
+    return server;
+};

package/{test_utils.js → test_utils/test_cli_command.js}

@@ -1,19 +1,8 @@
-/* eslint-disable no-console */
 import { test, expect, describe, beforeAll, afterAll } from '@jest/globals';
-import emocks from 'emocks';
-import express from 'express';
 import { fork } from 'node:child_process';
 import { join } from 'node:path';
-const runMockServer = async (mockDir) => new Promise((resolve) => {
-    const app = express();
-    app.use(express.json());
-    app.use('/', emocks(join(process.cwd(), 'mocks', mockDir)));
-    const server = app.listen(0);
-    server.on('listening', () => {
-        console.log(`Mock server listening at ${server.address().port}`);
-    });
-    resolve(server);
-});
+import { log } from '../log.js';
+import { runMockServer } from './mock_server.js';
 export const testCliCommand = ({ args, name, expected, mockDir = 'main', }) => {
     let server;
     describe(name, () => {
@@ -33,10 +22,10 @@ export const testCliCommand = ({ args, name, expected, mockDir = 'main', }) => {
             const cp = fork(join(process.cwd(), './dist/index.js'), [
                 '--api-host',
                 `http://localhost:${server.address().port}`,
-                '--api-key',
-                'test-key',
                 '--output',
                 'yaml',
+                '--api-key',
+                'test-key',
                 ...args,
             ], {
                 stdio: 'pipe',
@@ -47,15 +36,13 @@ export const testCliCommand = ({ args, name, expected, mockDir = 'main', }) => {
                 });
                 cp.stderr?.on('data', (data) => {
                     error += data.toString();
+                    log.error(data.toString());
                 });
                 cp.on('error', (err) => {
                     throw err;
                 });
                 cp.on('close', (code) => {
                     try {
-                        if (code !== 0 && error) {
-                            console.error(error);
-                        }
                         expect(code).toBe(0);
                         if (code === 0 && expected) {
                             if (expected.snapshot) {