[gradle] generate initial files for convention plugin usage

udpates 19615
jhipster · Dec 12, 2023 · 8e02b20 · 8e02b20
1 parent 9eb9eea
commit 8e02b20
Show file tree

Hide file tree

Showing 8 changed files with 35 additions and 1 deletion.
diff --git a/generators/git/templates/.gitignore.jhi.ejs b/generators/git/templates/.gitignore.jhi.ejs
@@ -79,6 +79,8 @@ out/
 ######################
 .gradle/
 /build/
+/buildSrc/.gradle/
+/buildSrc/build/
 
 ######################
 # Package Files

diff --git a/generators/gradle/__snapshots__/generator.spec.js.snap b/generators/gradle/__snapshots__/generator.spec.js.snap
@@ -17,6 +17,9 @@ exports[`generator - gradle with empty configuration should generate only gradle
   "gradlew.bat": {
     "stateCleared": "modified",
   },
+  "buildSrc/build.gradle": {
+    "stateCleared": "modified"
+  }
 }
 `;
 
@@ -37,5 +40,8 @@ exports[`generator - gradle with valid configuration should generate only gradle
   "gradlew.bat": {
     "stateCleared": "modified",
   },
+  "buildSrc/build.gradle": {
+    "stateCleared": "modified"
+  }
 }
 `;
diff --git a/generators/gradle/files.ts b/generators/gradle/files.ts
@@ -20,7 +20,7 @@
 export default {
   gradle: [
     {
-      templates: ['.prettierignore.jhi.gradle', 'gradle/wrapper/gradle-wrapper.properties'],
+      templates: ['.prettierignore.jhi.gradle', 'gradle/wrapper/gradle-wrapper.properties', 'buildSrc/build.gradle'],
     },
     {
       transform: false,

diff --git a/generators/gradle/generator.ts b/generators/gradle/generator.ts
@@ -32,6 +32,7 @@ import {
   addGradlePluginCallback,
   addGradlePluginManagementCallback,
   addGradlePropertyCallback,
+  addGradleBuildSrcDependencyCallback,
 } from './internal/needles.js';
 
 export default class GradleGenerator extends BaseApplicationGenerator {
@@ -73,6 +74,8 @@ export default class GradleGenerator extends BaseApplicationGenerator {
         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.addGradleBuildSrcDependency = dependency =>
+          this.editFile('buildSrc/build.gradle', addGradleBuildSrcDependencyCallback(dependency));
       },
     });
   }

diff --git a/generators/gradle/internal/needles.ts b/generators/gradle/internal/needles.ts
@@ -31,6 +31,12 @@ export const addGradleDependencyCallback = ({ groupId, artifactId, version, scop
     contentToAdd: `${scope} "${groupId}:${artifactId}${version ? `:${version}` : ''}"`,
   });
 
+export const addGradleBuildSrcDependencyCallback = ({ groupId, artifactId, version, scope }: GradleDependency) =>
+  createNeedleCallback({
+    needle: 'gradle-build-src-dependency',
+    contentToAdd: `${scope} "${groupId}:${artifactId}${version ? `:${version}` : ''}"`,
+  });
+
 export const addGradlePluginCallback = ({ id, version }: GradlePlugin) =>
   createNeedleCallback({
     needle: 'gradle-plugins',

diff --git a/generators/gradle/needles.spec.ts b/generators/gradle/needles.spec.ts
@@ -18,6 +18,7 @@ class mockBlueprintSubGen extends BaseApplicationGenerator {
         source.addGradleDependency?.({ scope: 'scope4', groupId: 'group4', artifactId: 'name4' });
         source.applyFromGradle?.({ script: 'name.gradle' });
         source.addGradleMavenRepository?.({ url: 'url', username: 'username', password: 'password' });
+        source.addGradleBuildSrcDependency?.({ scope: 'scope5', groupId: 'group5', artifactId: 'name5', version: 'version5' });
       },
     });
   }
@@ -71,4 +72,8 @@ describe('needle API server gradle: JHipster server generator with blueprint', (
         '    }',
     );
   });
+
+  it('Assert buildSrc/build.gradle has the Dependency with version added', () => {
+    runResult.assertFileContent('buildSrc/build.gradle', 'scope5 "group5:name5:version5"');
+  });
 });
diff --git a/generators/gradle/templates/buildSrc/build.gradle.ejs b/generators/gradle/templates/buildSrc/build.gradle.ejs
@@ -0,0 +1,11 @@
+plugins {
+    id 'groovy-gradle-plugin'
+}
+
+repositories {
+    gradlePluginPortal()
+}
+
+dependencies {
+    // jhipster-needle-gradle-build-src-dependency - JHipster will add additional dependencies for convention plugins here
+}
diff --git a/generators/gradle/types.d.ts b/generators/gradle/types.d.ts
@@ -15,4 +15,5 @@ export type GradleSourceType = {
   addGradlePluginManagement?(pluginManagement: GradlePlugin): void;
   addGradleProperty?(property: GradleProperty): void;
   addGradleMavenRepository?(repository: GradleRepository): void;
+  addGradleBuildSrcDependency?(dependency: GradleDependency): void;
 };