fix(#758): add path.join to build os-dependent java binary path

.github/workflows/build.yml

@@ -7,23 +7,23 @@ on:
       - master
       - renovate/**
   pull_request:
-    types: [ assigned, opened, synchronize, reopened ]
+    types: [assigned, opened, synchronize, reopened]
 jobs:
   build:
     name: Build
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node-version: [ 18.x ]
+        node-version: [18.x]
 
     steps:
       - name: Checkout
         uses: actions/checkout@v4
 
-      - name: Use Node.js ${{matrix.node-version }}
+      - name: Use Node.js ${{ matrix.node-version }}
         uses: actions/setup-node@v4
         with:
-          node-version: ${{matrix.node-version }}
+          node-version: ${{ matrix.node-version }}
 
       - name: Install
         run: yarn --frozen-lockfile
@@ -48,13 +48,13 @@ jobs:
           path: dist/apps/package.tgz
 
   e2e:
-    name: "E2E local: (${{ matrix.os }})"
+    name: 'E2E local: (${{ matrix.os }})'
     needs: build
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        os: [ ubuntu-latest, macos-latest ]
-        node-version: [ 18.x ]
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        node-version: [18.x]
 
     steps:
       - name: Checkout
@@ -69,7 +69,35 @@ jobs:
         with:
           name: package.tgz
 
-      - name: Test
+      - if: ${{matrix.os  == 'windows-latest'}}
+        name: Test Windows
+        run: |
+          $env:JAVA_HOME = $env:JAVA_HOME_11_X64
+          cd .\examples
+          yarn global add json; $yarn_global_bin=yarn global bin; $env:PATH += ";$yarn_global_bin"
+          yarn cache clean; yarn add $env:GITHUB_WORKSPACE\package.tgz
+          npm run oa version
+          npm run oa completion
+          npm run oa help
+          npm run oa help generate
+          npm run oa version-manager help
+          npm run oa generate -- -g ruby -i https://raw.githubusercontent.com/OpenAPITools/openapi-generator/master/modules/openapi-generator/src/test/resources/3_0/petstore.yaml -o $env:GITHUB_WORKSPACE\tmp\ruby-client
+          npm run oa version-manager set 3.0.0; $version=npm run oa version; if (-not ($version.Contains('3.0.0'))) { exit 1 }
+          npm run oa version-manager set 4.0; $version=npm run oa version; if (-not ($version.Contains('4.0.3'))) { exit 1 }
+          npm run oa version-manager set 4.3.1; $version=npm run oa version; if (-not ($version.Contains('4.3.1'))) { exit 1 }
+          npm run oa version-manager set 4.3.1; $version=npm run oa version; if (-not ($version.Contains('4.3.1'))) { exit 1 }
+          json -I -f openapitools.json -e "this['generator-cli']['storageDir']='./my/storage/'"
+          npm run oa version-manager set 4.3.0; $version=npm run oa version; if (-not ($version.Contains('4.3.0'))) { exit 1 }
+          if (-not (Test-Path .\my\storage\4.3.0.jar)) { exit 1 }
+          json -I -f openapitools.json -e "this['generator-cli']['storageDir']='~/my/storage/'"
+          npm run oa version-manager set 4.3.1; $version=npm run oa version; if (-not ($version.Contains('4.3.1'))) { exit 1 }
+          if (-not (Test-Path ~\my\storage\4.3.1.jar)) { exit 1 }
+          npm run oa:generate; mkdir .\foo; cd .\foo; npm run oa:generate
+          cd ..
+          ri env:JAVA_HOME
+          npm run oa:generate; mkdir .\bar; cd .\bar; npm run oa:generate
+      - if: ${{matrix.os  != 'windows-latest'}}
+        name: Test Ubuntu/MacOS
         run: |
           cd ./examples
           yarn global add json && export PATH="$(yarn global bin):$PATH"
@@ -91,6 +119,9 @@ jobs:
           (npm run oa version-manager set 4.3.1 && npm run oa version | grep -q '4.3.1') || exit 1
           test -f ~/my/storage/4.3.1.jar || exit 1
           npm run oa:generate && mkdir ./foo && cd ./foo && npm run oa:generate
+          cd ..
+          unset JAVA_HOME
+          npm run oa:generate && mkdir ./bar && cd ./bar && npm run oa:generate
 
 #  release:
 #    if: github.event.pull_request.merged == 'true'

apps/generator-cli/src/README.md

@@ -10,7 +10,7 @@ OpenAPI Generator allows generation of API client libraries (SDK generation), se
 configuration automatically given an OpenAPI Spec (both 2.0 and 3.0 are supported). Please see
 [OpenAPITools/openapi-generator](https://github.com/OpenAPITools/openapi-generator).
 
-The OpenAPI Generator is a Java project. `openapi-generator-cli` will download the appropriate JAR file and invoke the `java` executable to run the OpenAPI Generator. You must have the `java` binary executable available on your `PATH` or have set `JAVA_HOME` correctly for this to work.
+The OpenAPI Generator is a Java project. `openapi-generator-cli` will download the appropriate JAR file and invoke the `java` executable to run the OpenAPI Generator. You must have the `java` binary executable available on your `PATH` or have set `JAVA_HOME` correctly for this to work. (JDK 11 is the minimal version supported. To install OpenJDK, please visit https://adoptium.net/)
 
 If you find this tool useful, please consider sponsoring this project financially via https://opencollective.com/openapi_generator or directly to [Kay Schecker](https://github.com/sponsors/kay-schecker) (the author of this tool) :pray:
 
@@ -115,7 +115,7 @@ Initially the file has the following content:
   "$schema": "node_modules/@openapitools/openapi-generator-cli/config.schema.json",
   "spaces": 2,
   "generator-cli": {
-    "version": "4.3.1" // or the current latest version ;)
+    "version": "7.8.0" // or the current latest version ;)
   }
 }
 ```
@@ -124,7 +124,7 @@ This configuration indicates the following:
 
 - the json file shall be formatted using **2 spaces**
 - the jar files shall be downloaded to *./my/custom/storage/dir*
-- the generator-cli version 4.3.1 is used
+- the generator-cli version 7.8.0 is used
 
 Further it is also possible to configure generators, for example:
 
@@ -133,7 +133,7 @@ Further it is also possible to configure generators, for example:
   "$schema": "node_modules/@openapitools/openapi-generator-cli/config.schema.json",
   "spaces": 2,
   "generator-cli": {
-    "version": "4.3.1",
+    "version": "7.8.0",
     "storageDir": "~/my/custom/storage/dir", // optional
     "generators": { // optional
       "v2.0": { // any name you like (just printed to the console log or reference it using --generator-key) 
@@ -185,7 +185,7 @@ If you're using a private maven registry you can configure the `downloadUrl` and
   "$schema": "node_modules/@openapitools/openapi-generator-cli/config.schema.json",
   "spaces": 2,
   "generator-cli": {
-    "version": "5.3.0",
+    "version": "7.8.0",
     "repository": {
       "queryUrl": "https://private.maven.intern/solrsearch/select?q=g:${group.id}+AND+a:${artifact.id}&core=gav&start=0&rows=200",
       "downloadUrl": "https://private.maven.intern/maven2/${groupId}/${artifactId}/${versionName}/${artifactId}-${versionName}.jar"
@@ -196,6 +196,44 @@ If you're using a private maven registry you can configure the `downloadUrl` and
 
 If the `version` property param is set it is not necessary to configure the `queryUrl`.
 
+### Use locally built JAR
+In order to use a locally built jar of the generator CLI, you can copy the jar from your local build (i.e. if you were to `build` the [OpenAPITools/openapi-generator](https://github.com/OpenAPITools/openapi-generator) repository it would be in `~/openapi-generator/modules/openapi-generator-cli/target/openapi-generator-cli.jar`) into `./node_modules/@openapitools/openapi-generator-cli/versions/` and change the `version` in the `openapitools.json` file to the base name of the jar file.
+E.g.:
+```sh
+cd openapi-generator
+./mvnw clean package
+cp ./modules/openapi-generator-cli/target/openapi-generator-cli.jar /your/project/node_modules/@openapitools/openapi-generator-cli/versions/my-local-snapshot.jar
+```
+and then:
+```json
+{
+  "$schema": "./node_modules/@openapitools/openapi-generator-cli/config.schema.json",
+  "spaces": 2,
+  "generator-cli": {
+    "version": "my-local-snapshot",
+  }
+}
+```
+
+### Use nightly `SNAPSHOT` build
+Change your `openapitools.json` to:
+
+```json
+{
+  "$schema": "node_modules/@openapitools/openapi-generator-cli/config.schema.json",
+  "spaces": 2,
+  "generator-cli": {
+    "version": "7.9.0-20240829.123431-22",
+    "repository": {
+      "downloadUrl": "https://oss.sonatype.org/content/repositories/snapshots/org/openapitools/openapi-generator-cli/7.9.0-SNAPSHOT/openapi-generator-cli-${versionName}.jar"
+    }
+  }
+}
+```
+
+Example is with a snapshot of `7.9.0`, please change the `version` and `downloadUrl` accordingly.
+You can find all snapshots [here](https://oss.sonatype.org/content/repositories/snapshots/org/openapitools/openapi-generator-cli/).
+
 ## Run specific generators
 
 | cmd                                                      | v3.0 runs | v2.0 runs |
@@ -231,7 +269,7 @@ more information about the possible arguments and a detailed usage manual of the
 
 ```sh
 npm install @openapitools/openapi-generator-cli@previous
-npm i @openapitools/openapi-generator-cli@1.0.18-4.3.1                                         
+npm i @openapitools/openapi-generator-cli@1.0.18-4.3.1
 ```
 
 or using yarn

apps/generator-cli/src/app/app.module.ts

@@ -1,16 +1,33 @@
-import {Inject, Module, OnApplicationBootstrap} from '@nestjs/common';
-import {HttpModule} from '@nestjs/axios';
-import {Command} from 'commander';
+import { Inject, Module, OnApplicationBootstrap } from '@nestjs/common';
+import { HttpModule, HttpModuleOptions } from '@nestjs/axios';
+import { Command } from 'commander';
 
-import {COMMANDER_PROGRAM, LOGGER} from './constants';
-import {VersionManagerController} from './controllers/version-manager.controller';
-import {ConfigService, GeneratorService, PassThroughService, UIService, VersionManagerService} from './services';
+import { COMMANDER_PROGRAM, LOGGER } from './constants';
+import { VersionManagerController } from './controllers/version-manager.controller';
+import {
+  ConfigService,
+  GeneratorService,
+  PassThroughService,
+  UIService,
+  VersionManagerService,
+} from './services';
+import { HttpsProxyAgent } from 'https-proxy-agent';
+
+const proxyUrl = process.env.HTTP_PROXY || process.env.HTTPS_PROXY;
+const httpModuleConfig: HttpModuleOptions = {};
+
+if (proxyUrl) {
+  httpModuleConfig.proxy = false;
+  httpModuleConfig.httpsAgent = new HttpsProxyAgent(proxyUrl);
+}
 
 @Module({
-  imports: [HttpModule],
-  controllers: [
-    VersionManagerController
+  imports: [
+    HttpModule.register({
+      ...httpModuleConfig,
+    }),
   ],
+  controllers: [VersionManagerController],
   providers: [
     UIService,
     ConfigService,
@@ -19,34 +36,37 @@ import {ConfigService, GeneratorService, PassThroughService, UIService, VersionM
     VersionManagerService,
     {
       provide: COMMANDER_PROGRAM,
-      useValue: new Command('openapi-generator-cli').helpOption(false).usage('<command> [<args>]')
+      useValue: new Command('openapi-generator-cli')
+        .helpOption(false)
+        .usage('<command> [<args>]')
+        .option(
+          '--openapitools <openapitools.json>',
+          'Use the specified openapi-generator-cli configuration file',
+        ),
     },
-    {provide: LOGGER, useValue: console}
-  ]
+    { provide: LOGGER, useValue: console },
+  ],
 })
 export class AppModule implements OnApplicationBootstrap {
-
   constructor(
     @Inject(COMMANDER_PROGRAM) private readonly program: Command,
     private readonly versionManager: VersionManagerService,
-    private readonly passThroughService: PassThroughService
-  ) {
-  }
+    private readonly passThroughService: PassThroughService,
+  ) {}
 
   onApplicationBootstrap = async () => {
-
     let selectedVersion = this.versionManager.getSelectedVersion();
 
     if (!selectedVersion) {
-      const [{version}] = await this.versionManager.search(['latest']).toPromise();
+      const [{ version }] = await this.versionManager
+        .search(['latest'])
+        .toPromise();
       await this.versionManager.setSelectedVersion(version);
       selectedVersion = version;
     }
 
     await this.versionManager.downloadIfNeeded(selectedVersion);
     await this.passThroughService.init();
     this.program.parse(process.argv);
-
   };
-
 }

apps/generator-cli/src/app/helpers/index.ts

@@ -1,11 +1,13 @@
-const isWin = () => process.platform === 'win32';
+import path from 'path';
+
+export const isWin = () => process.platform === 'win32';
 
 /**
  * If JAVA_HOME is set, it returns `$JAVA_HOME/bin/java`
  * otherwise it returns `java` and it has to be in the `PATH`
  */
 export const javaCmd: string = process.env['JAVA_HOME']
   ? isWin()
-    ? `"${process.env['JAVA_HOME']}/bin/java"`
-    : `${process.env['JAVA_HOME']}/bin/java`
+    ? `"${path.join(process.env['JAVA_HOME'], 'bin', 'java')}"`
+    : `${path.join(process.env['JAVA_HOME'], 'bin', 'java')}`
   : 'java';

apps/generator-cli/src/app/services/config.service.spec.ts

@@ -1,19 +1,28 @@
 import { Test } from '@nestjs/testing';
+import { Command, createCommand } from 'commander';
 import { ConfigService } from './config.service';
-import { LOGGER } from '../constants';
+import { LOGGER, COMMANDER_PROGRAM } from '../constants';
 
 jest.mock('fs-extra');
 // eslint-disable-next-line @typescript-eslint/no-var-requires
 const fs = jest.mocked(require('fs-extra'));
 
 describe('ConfigService', () => {
   let fixture: ConfigService;
+  let program: Command;
 
   const log = jest.fn();
 
   beforeEach(async () => {
+    program = createCommand();
+    jest.spyOn(program, 'helpInformation');
+
     const moduleRef = await Test.createTestingModule({
-      providers: [ConfigService, { provide: LOGGER, useValue: { log } }],
+      providers: [
+        ConfigService,
+        { provide: LOGGER, useValue: { log } },
+        { provide: COMMANDER_PROGRAM, useValue: program },
+      ],
     }).compile();
 
     fixture = moduleRef.get(ConfigService);
@@ -141,5 +150,39 @@ describe('ConfigService', () => {
         );
       });
     });
+
+    describe('configFileOrDefault()', () => {
+      describe('--openapitools set', () => {
+        beforeEach(async () => {
+          program = createCommand();
+          program.opts().openapitools = '/tmp/myopenapitools.json';
+
+          const moduleRef = await Test.createTestingModule({
+            providers: [
+              ConfigService,
+              { provide: LOGGER, useValue: { log } },
+              { provide: COMMANDER_PROGRAM, useValue: program },
+            ],
+          }).compile();
+
+          fixture = moduleRef.get(ConfigService);
+          fs.writeJSONSync.mockReset();
+          fs.readJSONSync.mockReset();
+          fs.ensureFileSync.mockReset();
+        });
+        it('returns path set at cli, if openapitools argument provided', () => {
+          expect(fixture.configFile).toEqual('/tmp/myopenapitools.json');
+        });
+      });
+      describe('--openapitools not set', () => {
+        it('returns default path, if openapitools argument not provided', () => {
+          expect(
+            fixture.configFile.endsWith(
+              'openapi-generator-cli/openapitools.json'
+            )
+          ).toBeTruthy();
+        });
+      });
+    });
   });
 });