generator-jhipster 7.1.0 → 7.4.0

package/generators/java/index.cjs

@@ -0,0 +1,226 @@
+/**
+ * Copyright 2013-2021 the original author or authors from the JHipster project.
+ *
+ * This file is part of the JHipster project, see https://www.jhipster.tech/
+ * for more information.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/* eslint-disable consistent-return */
+const chalk = require('chalk');
+const { generateMixedChain } = require('../../lib/support/mixin.cjs');
+const {
+  INITIALIZING_PRIORITY,
+  PROMPTING_PRIORITY,
+  CONFIGURING_PRIORITY,
+  COMPOSING_PRIORITY,
+  LOADING_PRIORITY,
+  PREPARING_PRIORITY,
+  WRITING_PRIORITY,
+} = require('../../lib/constants/priorities.cjs');
+
+const { GENERATOR_JAVA } = require('../generator-list');
+const {
+  PACKAGE_NAME,
+  PACKAGE_NAME_DEFAULT_VALUE,
+  PRETTIER_JAVA_INDENT,
+  PRETTIER_JAVA_INDENT_DEFAULT_VALUE,
+  BUILD_TOOL,
+  BUILD_TOOL_DEFAULT_VALUE,
+  BUILD_TOOL_PROMPT_CHOICES,
+} = require('./constants.cjs');
+const { files } = require('./files.cjs');
+const { dependencyChain } = require('./mixin.cjs');
+
+const MixedChain = generateMixedChain(GENERATOR_JAVA);
+
+module.exports = class extends MixedChain {
+  constructor(args, options, features) {
+    super(args, options, { jhipsterModular: true, unique: 'namespace', ...features });
+
+    // Register options available to cli.
+    if (!this.fromBlueprint) {
+      this.registerCommonOptions();
+      this.registerChainOptions();
+    }
+
+    // Application context for templates
+    this.application = {};
+
+    if (this.options.help) return;
+
+    if (this.options.defaults) {
+      this.configureChain();
+    }
+  }
+
+  async _beforeQueue() {
+    if (!this.fromBlueprint) {
+      const configure = this.options.configure || !this.shouldComposeModular();
+      for (const generator of dependencyChain) {
+        await this.dependsOnJHipster(generator, [], { configure });
+      }
+      await this.composeWithBlueprints(GENERATOR_JAVA);
+    }
+  }
+
+  get initializing() {
+    return {
+      validateFromCli() {
+        this.checkInvocationFromCLI();
+      },
+      sayHello() {
+        if (!this.showHello()) return;
+        this.log(chalk.white('⬢ Welcome to the JHipster Java ⬢'));
+      },
+      loadRuntimeOptions() {
+        this.loadRuntimeOptions();
+      },
+      loadOptionsConstants() {
+        this.loadChainOptionsConstants();
+      },
+    };
+  }
+
+  get [INITIALIZING_PRIORITY]() {
+    if (this.delegateToBlueprint) return;
+    return this.initializing;
+  }
+
+  get prompting() {
+    return {
+      async showPrompts() {
+        if (this.shouldSkipPrompts()) return;
+        await this.prompt(
+          [
+            {
+              name: PACKAGE_NAME,
+              type: 'input',
+              validate: input => this.validatePackageName(input),
+              message: 'What is your default Java package name?',
+              default: () => this.sharedData.getConfigDefaultValue(PACKAGE_NAME, PACKAGE_NAME_DEFAULT_VALUE),
+            },
+            {
+              name: PRETTIER_JAVA_INDENT,
+              type: 'input',
+              message: 'What is the Java indentation?',
+              default: () => this.sharedData.getConfigDefaultValue(PRETTIER_JAVA_INDENT, PRETTIER_JAVA_INDENT_DEFAULT_VALUE),
+            },
+            {
+              name: BUILD_TOOL,
+              type: 'list',
+              message: 'What tool do you want to use to build backend?',
+              choices: () => this.sharedData.getConfigChoices(BUILD_TOOL, BUILD_TOOL_PROMPT_CHOICES),
+              default: () => this.sharedData.getConfigDefaultValue(BUILD_TOOL, BUILD_TOOL_DEFAULT_VALUE),
+            },
+          ],
+          this.config
+        );
+      },
+    };
+  }
+
+  get [PROMPTING_PRIORITY]() {
+    if (this.delegateToBlueprint) return;
+    return this.prompting;
+  }
+
+  get configuring() {
+    return {
+      configure() {
+        this.configureJava();
+      },
+    };
+  }
+
+  get [CONFIGURING_PRIORITY]() {
+    if (this.delegateToBlueprint) return;
+    return this.configuring;
+  }
+
+  get composing() {
+    return {
+      async compose() {
+        if (!this.shouldComposeModular()) return;
+        await this.composeWithJavaConfig();
+      },
+    };
+  }
+
+  get [COMPOSING_PRIORITY]() {
+    if (this.delegateToBlueprint) return;
+    return this.composing;
+  }
+
+  get loading() {
+    return {
+      configureChain() {
+        this.configureChain();
+      },
+      loadConstants() {
+        this.loadChainConstants(this.application);
+      },
+      loadConfig() {
+        this.loadChainConfig(this.application);
+      },
+    };
+  }
+
+  get [LOADING_PRIORITY]() {
+    if (this.delegateToBlueprint) return;
+    return this.loading;
+  }
+
+  get preparing() {
+    return {
+      prepareDerivedProperties() {
+        this.prepareChainDerivedProperties(this.application);
+      },
+    };
+  }
+
+  get [PREPARING_PRIORITY]() {
+    if (this.delegateToBlueprint) return;
+    return this.preparing;
+  }
+
+  get writing() {
+    return {
+      async writeFiles() {
+        if (this.shouldSkipFiles()) return;
+        await this.writeFiles({ sections: files, context: this.application });
+      },
+    };
+  }
+
+  get [WRITING_PRIORITY]() {
+    if (this.delegateToBlueprint) return;
+    return this.writing;
+  }
+
+  /*
+   * Start of local public API, blueprints may override to customize the generator behavior.
+   */
+
+  /**
+   * Validates packageName
+   * @param String input - Package name to be checked
+   * @returns Boolean
+   */
+  validatePackageName(input) {
+    if (!/^([a-z_]{1}[a-z0-9_]*(\.[a-z_]{1}[a-z0-9_]*)*)$/.test(input)) {
+      return 'The package name you have provided is not a valid Java package name.';
+    }
+    return true;
+  }
+};

package/generators/java/mixin.cjs

@@ -0,0 +1,120 @@
+/**
+ * Copyright 2013-2021 the original author or authors from the JHipster project.
+ *
+ * This file is part of the JHipster project, see https://www.jhipster.tech/
+ * for more information.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+const { defaults } = require('lodash');
+
+const { GENERATOR_MAVEN, GENERATOR_GRADLE } = require('../generator-list');
+const { requiredConfig, defaultConfig } = require('./config.cjs');
+const { options } = require('./options.cjs');
+const {
+  JAVA_VERSION,
+  JAVA_COMPATIBLE_VERSIONS,
+  JAVA_APP_VERSION,
+  JAVA_SOURCE_DIR,
+  JAVA_RESOURCE_DIR,
+  JAVA_TEST_DIR,
+  PACKAGE_NAME,
+  PRETTIER_JAVA_INDENT,
+  BUILD_TOOL,
+  BUILD_TOOL_MAVEN,
+  BUILD_TOOL_GRADLE,
+  BUILD_DESTINATION,
+} = require('./constants.cjs');
+
+const { GENERATOR_INIT } = require('../generator-list');
+
+module.exports.dependencyChain = [GENERATOR_INIT];
+
+module.exports.mixin = parent =>
+  class extends parent {
+    /**
+     * Load java options constants.
+     */
+    loadJavaOptionsConstants(into = this) {}
+
+    /**
+     * Register and parse java options.
+     */
+    getJavaOptions() {
+      return options;
+    }
+
+    /**
+     * Load required java configs into config.
+     */
+    configureJava() {
+      this.config.defaults(requiredConfig);
+    }
+
+    /**
+     * Load java configs into into.
+     * all variables should be set to into,
+     * all variables should be referred from config,
+     * @param {any} config - config to load config from
+     * @param {any} into - destination context to use default is context
+     */
+    loadJavaConfig(into = this, config = this.jhipsterConfig) {
+      config = defaults({}, config, defaultConfig);
+      into[PACKAGE_NAME] = config[PACKAGE_NAME];
+      into[PRETTIER_JAVA_INDENT] = config[PRETTIER_JAVA_INDENT];
+      into[BUILD_TOOL] = config[BUILD_TOOL];
+      into[BUILD_DESTINATION] = config[BUILD_DESTINATION];
+    }
+
+    /**
+     * Prepare derived java properties into fromInto.
+     * @param {any} fromInto - source/destination context
+     */
+    prepareJavaDerivedProperties(fromInto = this) {
+      fromInto.javaMainClass = this.getMainClassName(fromInto.baseName);
+      fromInto.packageFolder = fromInto[PACKAGE_NAME].replace(/\./g, '/');
+
+      const buildTool = fromInto[BUILD_TOOL];
+      fromInto.buildToolNo = !buildTool || buildTool === 'no';
+      fromInto.buildToolMaven = buildTool === BUILD_TOOL_MAVEN;
+      fromInto.buildToolGradle = buildTool === BUILD_TOOL_GRADLE;
+    }
+
+    /**
+     * Load java constants into 'into'.
+     * @param {Object} into - destination context
+     */
+    loadJavaConstants(into = this) {
+      into.JAVA_VERSION = JAVA_VERSION;
+      into.JAVA_COMPATIBLE_VERSIONS = JAVA_COMPATIBLE_VERSIONS;
+      into.JAVA_APP_VERSION = JAVA_APP_VERSION;
+      into.JAVA_SOURCE_DIR = JAVA_SOURCE_DIR;
+      into.JAVA_RESOURCE_DIR = JAVA_RESOURCE_DIR;
+      into.JAVA_TEST_DIR = JAVA_TEST_DIR;
+    }
+
+    /**
+     * Compose with selected java configuration.
+     */
+    async composeWithJavaConfig(config = this.jhipsterConfig) {
+      config = defaults({}, config, defaultConfig);
+      const buildTool = config[BUILD_TOOL];
+      if (buildTool === BUILD_TOOL_MAVEN) {
+        await this.composeWithJHipster(GENERATOR_MAVEN);
+      } else if (buildTool === BUILD_TOOL_GRADLE) {
+        await this.composeWithJHipster(GENERATOR_GRADLE);
+      } else if (buildTool.includes(':')) {
+        await this.composeWithJHipster(buildTool);
+      }
+    }
+  };

package/generators/java/options.cjs

@@ -0,0 +1,32 @@
+/**
+ * Copyright 2013-2021 the original author or authors from the JHipster project.
+ *
+ * This file is part of the JHipster project, see https://www.jhipster.tech/
+ * for more information.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+const { PACKAGE_NAME, PACKAGE_NAME_DESCRIPTION, BUILD_TOOL, BUILD_TOOL_DESCRIPTION } = require('./constants.cjs');
+
+module.exports.options = {
+  [PACKAGE_NAME]: {
+    desc: PACKAGE_NAME_DESCRIPTION,
+    type: String,
+    scope: 'storage',
+  },
+  [BUILD_TOOL]: {
+    desc: BUILD_TOOL_DESCRIPTION,
+    type: String,
+    scope: 'storage',
+  },
+};

package/generators/java/templates/.editorconfig.jhi.java.ejs

@@ -0,0 +1,23 @@
+<%#
+ Copyright 2013-2021 the original author or authors from the JHipster project.
+
+ This file is part of the JHipster project, see https://www.jhipster.tech/
+ for more information.
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+      https://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-%>
+<&_ if (!fragment.section) { -&>
+# java rules:
+[*.java]
+indent_size = <%= prettierJavaIndent %>
+<&_ } -&>

package/generators/java/templates/.gitignore.jhi.java.ejs

@@ -0,0 +1,34 @@
+<%#
+ Copyright 2013-2021 the original author or authors from the JHipster project.
+
+ This file is part of the JHipster project, see https://www.jhipster.tech/
+ for more information.
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+      https://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-%>
+<&_ if (!fragment.section) { -&>
+######################
+# Package Files
+######################
+*.jar
+*.war
+*.ear
+*.db
+*.class
+
+######################
+# Directories
+######################
+/bin/
+/deploy/
+<&_ } -&>

package/generators/java/templates/.prettierrc.yml.jhi.java.ejs

@@ -0,0 +1,25 @@
+<%#
+ Copyright 2013-2021 the original author or authors from the JHipster project.
+
+ This file is part of the JHipster project, see https://www.jhipster.tech/
+ for more information.
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+      https://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-%>
+<&_ if (!fragment.section) { -&>
+# java rules:
+overrides:
+  - files: '*.java'
+    options:
+      tabWidth: <%= prettierJavaIndent %>
+<&_ } -&>

package/generators/kubernetes/esm.mjs

@@ -0,0 +1,21 @@
+/**
+ * Copyright 2013-2021 the original author or authors from the JHipster project.
+ *
+ * This file is part of the JHipster project, see https://www.jhipster.tech/
+ * for more information.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import generator from './index.js';
+
+export default generator;

package/generators/kubernetes/files.js

@@ -17,6 +17,15 @@
  * limitations under the License.
  */
 
+const { ELASTICSEARCH } = require('../../jdl/jhipster/search-engine-types');
+const { GATEWAY, MONOLITH } = require('../../jdl/jhipster/application-types');
+const { JWT } = require('../../jdl/jhipster/authentication-types');
+const { PROMETHEUS } = require('../../jdl/jhipster/monitoring-types');
+const { CONSUL, EUREKA } = require('../../jdl/jhipster/service-discovery-types');
+const databaseTypes = require('../../jdl/jhipster/database-types');
+
+const NO_DATABASE = databaseTypes.NO;
+
 module.exports = {
   writeFiles,
 };
@@ -32,23 +41,26 @@ function writeFiles() {
         this.template('deployment.yml.ejs', `${appOut}/${appName}-deployment.yml`);
         this.template('service.yml.ejs', `${appOut}/${appName}-service.yml`);
         // If we choose microservice with no DB, it is trying to move _no.yml as prodDatabaseType is getting tagged as 'string' type
-        if (this.app.prodDatabaseType !== 'no') {
+        if (this.app.prodDatabaseType !== NO_DATABASE) {
           this.template(`db/${this.app.prodDatabaseType}.yml.ejs`, `${appOut}/${appName}-${this.app.prodDatabaseType}.yml`);
         }
-        if (this.app.searchEngine === 'elasticsearch') {
+        if (this.app.searchEngine === ELASTICSEARCH) {
           this.template('db/elasticsearch.yml.ejs', `${appOut}/${appName}-elasticsearch.yml`);
         }
-        if (this.app.applicationType === 'gateway' || this.app.applicationType === 'monolith') {
+        if (this.app.applicationType === GATEWAY || this.app.applicationType === MONOLITH) {
           if (this.istio) {
             this.template('istio/gateway.yml.ejs', `${appOut}/${appName}-gateway.yml`);
           } else if (this.kubernetesServiceType === 'Ingress') {
             this.template('ingress.yml.ejs', `${appOut}/${appName}-ingress.yml`);
           }
         }
-        if (!this.app.serviceDiscoveryType && this.app.authenticationType === 'jwt') {
+        if (!this.app.serviceDiscoveryType && this.app.authenticationType === JWT) {
           this.template('secret/jwt-secret.yml.ejs', `${appOut}/jwt-secret.yml`);
         }
-        if (this.monitoring === 'prometheus') {
+        if (this.app.prodDatabaseTypeCouchbase) {
+          this.template('secret/couchbase-secret.yml.ejs', `${appOut}/templates/couchbase-secret.yml`);
+        }
+        if (this.monitoring === PROMETHEUS) {
           this.template('monitoring/jhipster-prometheus-sm.yml.ejs', `${appOut}/${appName}-prometheus-sm.yml`);
         }
         if (this.istio) {
@@ -75,7 +87,7 @@ function writeFiles() {
 
     writePrometheusGrafanaFiles() {
       const monitOut = 'monitoring'.concat('-', suffix);
-      if (this.monitoring === 'prometheus') {
+      if (this.monitoring === PROMETHEUS) {
         this.template('monitoring/jhipster-prometheus-crd.yml.ejs', `${monitOut}/jhipster-prometheus-crd.yml`);
         this.template('monitoring/jhipster-prometheus-cr.yml.ejs', `${monitOut}/jhipster-prometheus-cr.yml`);
         this.template('monitoring/jhipster-grafana.yml.ejs', `${monitOut}/jhipster-grafana.yml`);
@@ -88,10 +100,10 @@ function writeFiles() {
 
     writeRegistryFiles() {
       const registryOut = 'registry'.concat('-', suffix);
-      if (this.serviceDiscoveryType === 'eureka') {
+      if (this.serviceDiscoveryType === EUREKA) {
         this.template('registry/jhipster-registry.yml.ejs', `${registryOut}/jhipster-registry.yml`);
         this.template('registry/application-configmap.yml.ejs', `${registryOut}/application-configmap.yml`);
-      } else if (this.serviceDiscoveryType === 'consul') {
+      } else if (this.serviceDiscoveryType === CONSUL) {
         this.template('registry/consul.yml.ejs', `${registryOut}/consul.yml`);
         this.template('registry/consul-config-loader.yml.ejs', `${registryOut}/consul-config-loader.yml`);
         this.template('registry/application-configmap.yml.ejs', `${registryOut}/application-configmap.yml`);

package/generators/kubernetes/generator.spec.mjs

@@ -0,0 +1,44 @@
+/**
+ * Copyright 2013-2021 the original author or authors from the JHipster project.
+ *
+ * This file is part of the JHipster project, see https://www.jhipster.tech/
+ * for more information.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import expect from 'expect';
+import lodash from 'lodash';
+import { basename, dirname } from 'path';
+import { fileURLToPath } from 'url';
+
+import Generator from './index.js';
+
+const { snakeCase } = lodash;
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
+
+const generator = basename(__dirname);
+
+describe(`JHipster ${generator} generator`, () => {
+  it('generator-list constant matches folder name', async () => {
+    await expect((await import('../generator-list.js')).default[`GENERATOR_${snakeCase(generator).toUpperCase()}`]).toBe(generator);
+  });
+  it('should be exported at package.json', async () => {
+    await expect((await import(`generator-jhipster/esm/generators/${generator}`)).default).toBe(Generator);
+  });
+  it('should support features parameter', () => {
+    const instance = new Generator([], { help: true }, { bar: true });
+    expect(instance.features.bar).toBe(true);
+  });
+});