Merge pull request #25631 from mshima/liquibase

adjusts to liquibase generator.

.github/workflows/generator-database-changelog-liquibase.yml

@@ -103,6 +103,8 @@ jobs:
       #----------------------------------------------------------------------
       # Launch tests
       #----------------------------------------------------------------------
+      - name: 'TESTS: check liquibase:diff'
+        run: ./mvnw liquibase:diff
       - name: 'TESTS: backend'
         run: npm run ci:backend:test
       - name: 'TESTS: frontend'

generators/app/__snapshots__/generator.spec.ts.snap

@@ -518,17 +518,17 @@ exports[`generator - app with default config should match snapshot 1`] = `
     "sonar-maven-plugin": "'SONAR-MAVEN-PLUGIN-VERSION'",
     "spotless-gradle-plugin": "'SPOTLESS-GRADLE-PLUGIN-VERSION'",
     "spotless-maven-plugin": "'SPOTLESS-MAVEN-PLUGIN-VERSION'",
-    "spring-boot": "'SPRING-BOOT-VERSION'",
     "spring-cloud-dependencies": "'SPRING-CLOUD-DEPENDENCIES-VERSION'",
-    "spring-dependency-management": "'SPRING-DEPENDENCY-MANAGEMENT-VERSION'",
     "springdoc": "'SPRINGDOC-VERSION'",
     "testng": "'TESTNG-VERSION'",
     "typesafe": "'TYPESAFE-VERSION'",
     "xmemcached": "'XMEMCACHED-VERSION'",
     "xmemcached-provider": "'XMEMCACHED-PROVIDER-VERSION'",
   },
+  "javaManagedProperties": {},
   "javaPackageSrcDir": "src/main/java/com/mycompany/myapp/",
   "javaPackageTestDir": "src/test/java/com/mycompany/myapp/",
+  "javaProperties": {},
   "javaVersion": "JAVA_VERSION",
   "jhiPrefix": "jhi",
   "jhiPrefixCapitalized": "Jhi",
@@ -1091,14 +1091,14 @@ exports[`generator - app with gateway should match snapshot 1`] = `
     "sonar-maven-plugin": "'SONAR-MAVEN-PLUGIN-VERSION'",
     "spotless-gradle-plugin": "'SPOTLESS-GRADLE-PLUGIN-VERSION'",
     "spotless-maven-plugin": "'SPOTLESS-MAVEN-PLUGIN-VERSION'",
-    "spring-boot": "'SPRING-BOOT-VERSION'",
     "spring-cloud-dependencies": "'SPRING-CLOUD-DEPENDENCIES-VERSION'",
-    "spring-dependency-management": "'SPRING-DEPENDENCY-MANAGEMENT-VERSION'",
     "springdoc": "'SPRINGDOC-VERSION'",
     "testng": "'TESTNG-VERSION'",
   },
+  "javaManagedProperties": {},
   "javaPackageSrcDir": "src/main/java/com/mycompany/myapp/",
   "javaPackageTestDir": "src/test/java/com/mycompany/myapp/",
+  "javaProperties": {},
   "javaVersion": "JAVA_VERSION",
   "jhiPrefix": "jhi",
   "jhiPrefixCapitalized": "Jhi",
@@ -1664,17 +1664,17 @@ exports[`generator - app with microservice should match snapshot 1`] = `
     "sonar-maven-plugin": "'SONAR-MAVEN-PLUGIN-VERSION'",
     "spotless-gradle-plugin": "'SPOTLESS-GRADLE-PLUGIN-VERSION'",
     "spotless-maven-plugin": "'SPOTLESS-MAVEN-PLUGIN-VERSION'",
-    "spring-boot": "'SPRING-BOOT-VERSION'",
     "spring-cloud-dependencies": "'SPRING-CLOUD-DEPENDENCIES-VERSION'",
-    "spring-dependency-management": "'SPRING-DEPENDENCY-MANAGEMENT-VERSION'",
     "springdoc": "'SPRINGDOC-VERSION'",
     "testng": "'TESTNG-VERSION'",
     "typesafe": "'TYPESAFE-VERSION'",
     "xmemcached": "'XMEMCACHED-VERSION'",
     "xmemcached-provider": "'XMEMCACHED-PROVIDER-VERSION'",
   },
+  "javaManagedProperties": {},
   "javaPackageSrcDir": "src/main/java/com/mycompany/myapp/",
   "javaPackageTestDir": "src/test/java/com/mycompany/myapp/",
+  "javaProperties": {},
   "javaVersion": "JAVA_VERSION",
   "jhiPrefix": "jhi",
   "jhiPrefixCapitalized": "Jhi",

generators/base-core/generator.ts

@@ -27,7 +27,7 @@ import { GeneratorMeta } from '@yeoman/types';
 import chalk from 'chalk';
 import { parse as parseYaml, stringify as stringifyYaml } from 'yaml';
 import * as _ from 'lodash-es';
-import { kebabCase } from 'lodash-es';
+import { kebabCase, snakeCase } from 'lodash-es';
 import { simpleGit } from 'simple-git';
 import type { CopyOptions } from 'mem-fs-editor';
 import type { Data as TemplateData, Options as TemplateOptions } from 'ejs';
@@ -60,6 +60,7 @@ import command from '../base/command.js';
 import { GENERATOR_JHIPSTER, YO_RC_FILE } from '../generator-constants.js';
 import { convertConfigToOption } from '../../lib/internal/index.js';
 import { getGradleLibsVersionsProperties } from '../gradle/support/dependabot-gradle.js';
+import { dockerPlaceholderGenerator } from '../docker/utils.js';
 
 const { merge, get, set } = _;
 const {
@@ -1000,10 +1001,18 @@ templates: ${JSON.stringify(existingTemplates, null, 2)}`;
    */
   prepareDependencies(
     map: Record<string, string>,
-    valuePlaceholder: (value: string) => string = value => `${_.snakeCase(value).toUpperCase()}_VERSION`,
+    valuePlaceholder?: 'java' | 'docker' | ((value: string) => string),
   ): Record<string, string> {
+    let placeholder: (value: string) => string;
+    if (valuePlaceholder === 'java') {
+      placeholder = value => `'${kebabCase(value).toUpperCase()}-VERSION'`;
+    } else if (valuePlaceholder === 'docker') {
+      placeholder = dockerPlaceholderGenerator;
+    } else {
+      placeholder = valuePlaceholder ?? (value => `${snakeCase(value).toUpperCase()}_VERSION`);
+    }
     if (this.useVersionPlaceholders) {
-      return Object.fromEntries(Object.keys(map).map(dep => [dep, valuePlaceholder(dep)]));
+      return Object.fromEntries(Object.keys(map).map(dep => [dep, placeholder(dep)]));
     }
     return {
       ...map,
@@ -1027,13 +1036,7 @@ templates: ${JSON.stringify(existingTemplates, null, 2)}`;
 
     const gradleLibsVersions = this.readTemplate(gradleCatalog)?.toString();
     if (gradleLibsVersions) {
-      Object.assign(
-        javaDependencies,
-        this.prepareDependencies(
-          getGradleLibsVersionsProperties(gradleLibsVersions!),
-          value => `'${kebabCase(value).toUpperCase()}-VERSION'`,
-        ),
-      );
+      Object.assign(javaDependencies, this.prepareDependencies(getGradleLibsVersionsProperties(gradleLibsVersions!), 'java'));
     }
   }
 

generators/base-workspaces/internal/docker-dependencies.ts

@@ -17,7 +17,7 @@
  * limitations under the License.
  */
 import { dockerContainers as elasticDockerContainer } from '../../generator-constants.js';
-import { dockerPlaceholderGenerator, getDockerfileContainers } from '../../docker/utils.js';
+import { getDockerfileContainers } from '../../docker/utils.js';
 
 export async function loadDockerDependenciesTask(this: any, { context = this } = {}) {
   const dockerfile = this.readTemplate(this.jhipsterTemplatePath('../../server/resources/Dockerfile'));
@@ -26,6 +26,6 @@ export async function loadDockerDependenciesTask(this: any, { context = this } =
       ...elasticDockerContainer,
       ...getDockerfileContainers(dockerfile),
     },
-    dockerPlaceholderGenerator,
+    'docker',
   );
 }

generators/bootstrap-application-server/generator.ts

@@ -16,7 +16,6 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import * as _ from 'lodash-es';
 
 import BaseApplicationGenerator from '../base-application/index.js';
 import { GENERATOR_BOOTSTRAP_APPLICATION_BASE, GENERATOR_BOOTSTRAP_APPLICATION_SERVER } from '../generator-list.js';
@@ -43,10 +42,10 @@ import {
 import { getGradleLibsVersionsProperties } from '../gradle/support/index.js';
 import { getPomVersionProperties } from '../maven/support/index.js';
 import { prepareField as prepareFieldForLiquibaseTemplates } from '../liquibase/support/index.js';
-import { dockerPlaceholderGenerator, getDockerfileContainers } from '../docker/utils.js';
+import { getDockerfileContainers } from '../docker/utils.js';
 import { GRADLE_VERSION } from '../gradle/constants.js';
 import { normalizePathEnd } from '../base/support/path.js';
-import { getFrontendAppName } from '../base/support/index.js';
+import { getFrontendAppName, mutateData } from '../base/support/index.js';
 import { getMainClassName } from '../java/support/index.js';
 import { loadConfig, loadDerivedConfig } from '../../lib/internal/index.js';
 import serverCommand from '../server/command.js';
@@ -82,24 +81,36 @@ export default class BoostrapApplicationServer extends BaseApplicationGenerator
         const gradleLibsVersions = this.readTemplate(
           this.jhipsterTemplatePath('../../server/resources/gradle/libs.versions.toml'),
         )?.toString();
-        application.packageInfoJavadocs = [];
-        application.javaDependencies = this.prepareDependencies(
+        const applicationJavaDependencies = this.prepareDependencies(
           {
             ...getPomVersionProperties(pomFile!),
             ...getGradleLibsVersionsProperties(gradleLibsVersions!),
           },
-          // Gradle doesn't allows snakeCase
-          value => `'${_.kebabCase(value).toUpperCase()}-VERSION'`,
+          'java',
         );
 
         const dockerfile = this.readTemplate(this.jhipsterTemplatePath('../../server/resources/Dockerfile'));
-        application.dockerContainers = this.prepareDependencies(
+        const applicationDockerContainers = this.prepareDependencies(
           {
             ...dockerContainers,
             ...getDockerfileContainers(dockerfile),
           },
-          dockerPlaceholderGenerator,
+          'docker',
         );
+
+        mutateData(application, {
+          packageInfoJavadocs: [],
+          javaProperties: {},
+          javaManagedProperties: {},
+          javaDependencies: ({ javaDependencies }) => ({
+            ...applicationJavaDependencies,
+            ...javaDependencies,
+          }),
+          dockerContainers: ({ dockerContainers: currentDockerContainers = {} }) => ({
+            ...applicationDockerContainers,
+            ...currentDockerContainers,
+          }),
+        });
       },
     });
   }

generators/gradle/generator.ts

@@ -89,7 +89,10 @@ export default class GradleGenerator extends BaseApplicationGenerator {
         source.addGradlePlugin = plugin => this.editFile('build.gradle', addGradlePluginCallback(plugin));
         source.addGradleMavenRepository = repository => this.editFile('build.gradle', addGradleMavenRepositoryCallback(repository));
         source.addGradlePluginManagement = plugin => this.editFile('settings.gradle', addGradlePluginManagementCallback(plugin));
-        source.addGradleProperty = property => this.editFile('gradle.properties', addGradlePropertyCallback(property));
+        source.addGradleProperty = property => {
+          application.javaProperties![property.property] = property.value!;
+          this.editFile('gradle.properties', addGradlePropertyCallback(property));
+        };
         source.addGradleDependencyCatalogVersions = (versions, { gradleVersionCatalogFile = 'gradle/libs.versions.toml' } = {}) =>
           this.editFile(gradleVersionCatalogFile, addGradleDependenciesCatalogVersionCallback(versions));
         source.addGradleDependencyCatalogVersion = (version, options) => source.addGradleDependencyCatalogVersions!([version], options);

generators/java/generator.ts

@@ -93,6 +93,8 @@ export default class JavaGenerator extends BaseApplicationGenerator {
   get preparing() {
     return this.asPreparingTaskGroup({
       prepareJavaApplication({ application, source }) {
+        source.hasJavaProperty = (property: string) => application.javaProperties![property] !== undefined;
+        source.hasJavaManagedProperty = (property: string) => application.javaManagedProperties![property] !== undefined;
         source.addJavaDependencies = (dependencies, options) => {
           if (application.buildToolMaven) {
             const annotationProcessors = dependencies.filter(dep => dep.scope === 'annotationProcessor');
@@ -145,12 +147,20 @@ export default class JavaGenerator extends BaseApplicationGenerator {
         source.addJavaDefinition = (definition, options) => {
           const { dependencies, versions } = definition;
           if (dependencies) {
-            source.addJavaDependencies!(dependencies, options);
+            source.addJavaDependencies!(
+              dependencies.filter(dep => {
+                if (dep.versionRef) {
+                  return versions?.find(({ name }) => name === dep.versionRef)?.version;
+                }
+                return true;
+              }),
+              options,
+            );
           }
           if (versions) {
             if (application.buildToolMaven) {
               source.addMavenDefinition!({
-                properties: versions.map(({ name, version }) => ({ property: `${name}.version`, value: version })),
+                properties: versions.filter(v => v.version).map(({ name, version }) => ({ property: `${name}.version`, value: version })),
               });
             }
             if (application.buildToolGradle) {

generators/java/types.d.ts

@@ -18,7 +18,7 @@ export type JavaArtifact = {
   classifier?: string;
 } & JavaArtifactType;
 
-export type JavaArtifactVersion = RequireOneOrNone<{ version: string; versionRef: string }, 'version' | 'versionRef'>;
+export type JavaArtifactVersion = RequireOneOrNone<{ version?: string; versionRef?: string }, 'version' | 'versionRef'>;
 
 export type JavaDependency = JavaArtifact & JavaArtifactVersion;
 
@@ -48,7 +48,13 @@ export type JavaApplication = BaseApplication &
 
     temporaryDir: string;
 
+    /** Java dependency versions */
     javaDependencies: Record<string, string>;
+    /** Known properties that can be used */
+    javaProperties: Record<string, string | null>;
+    /** Known managed properties that can be used */
+    javaManagedProperties: Record<string, string | null>;
+    /** Pre-defined package JavaDocs */
     packageInfoJavadocs: { packageName: string; documentation: string }[];
 
     prettierJava: boolean;
@@ -57,6 +63,13 @@ export type JavaApplication = BaseApplication &
   };
 
 export type JavaSourceType = {
+  /**
+   * Add a JavaDefinition to the application.
+   * A version requires a valid version otherwise it will be ignored.
+   * A dependency with versionRef requires a valid referenced version at `versions` otherwise it will be ignored.
+   */
   addJavaDefinition?(definition: JavaDefinition, options?: JavaNeedleOptions): void;
   addJavaDependencies?(dependency: JavaDependency[], options?: JavaNeedleOptions): void;
+  hasJavaProperty?(propertyName: string): boolean;
+  hasJavaManagedProperty?(propertyName: string): boolean;
 };

generators/languages/languages.spec.js

@@ -14,6 +14,7 @@ const generatorPath = join(__dirname, 'index.js');
 const createClientProject = options =>
   basicHelpers
     .runJHipster('app')
+    .withMockedGenerators(['jhipster:liquibase'])
     .withJHipsterConfig()
     .withOptions({
       ...options,