support dependencies and dependencies management in a build profile #9369

renanfranca · 2024-03-26T15:16:09Z

See

Support java build profile in gradle #8627

codecov · 2024-03-26T16:13:46Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (bb80629) to head (6d847d4).
Report is 7 commits behind head on main.

Additional details and impacted files

@@             Coverage Diff             @@
##                main     #9369   +/-   ##
===========================================
  Coverage     100.00%   100.00%           
- Complexity      2941      2950    +9     
===========================================
  Files            734       734           
  Lines          12778     12797   +19     
  Branches         257       259    +2     
===========================================
+ Hits           12778     12797   +19

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

murdos · 2024-03-26T20:55:06Z

...hipster/lite/module/infrastructure/secondary/javadependency/gradle/GradleCommandHandler.java

@@ -142,15 +144,15 @@ private Pattern needleForGradleDependencyScope(GradleDependencyScope gradleScope
    };
  }

-  private String dependencyDeclaration(JavaDependency dependency) {
+  private String dependencyDeclaration(JavaDependency dependency, Optional<BuildProfileId> buildProfile) {
    StringBuilder dependencyDeclaration = new StringBuilder()
      .append(indentation.times(1))
      .append(gradleDependencyScope(dependency).command())
      .append("(");
    if (dependency.scope() == JavaDependencyScope.IMPORT) {


It's a bit a shame to use a parameter Optional<BuildProfileId> for versionCatalogReference() where you only use Optional::isPresent.
Maybe:

Suggested change

if (dependency.scope() == JavaDependencyScope.IMPORT) {

var versionCatalogReference = forBuildProfile ? versionCatalogReferenceForBuildProfile(dependency) : versionCatalogReference(dependency);

if (dependency.scope() == JavaDependencyScope.IMPORT) {

murdos · 2024-03-26T20:55:52Z

...hipster/lite/module/infrastructure/secondary/javadependency/gradle/GradleCommandHandler.java

@@ -142,15 +144,15 @@ private Pattern needleForGradleDependencyScope(GradleDependencyScope gradleScope
    };
  }

-  private String dependencyDeclaration(JavaDependency dependency) {
+  private String dependencyDeclaration(JavaDependency dependency, Optional<BuildProfileId> buildProfile) {


You don't really need the buildProfile:

Suggested change

private String dependencyDeclaration(JavaDependency dependency, Optional<BuildProfileId> buildProfile) {

private String dependencyDeclaration(JavaDependency dependency, boolean forBuildProfile) {

murdos · 2024-03-26T21:06:06Z

src/test/java/tech/jhipster/lite/module/domain/JHipsterModulesFixture.java

@@ -55,11 +55,6 @@ public static JHipsterModule fullModule() {
          .pluginManagement(mavenEnforcerPluginManagement())
          .plugin(mavenEnforcerPlugin())
          .and()
-        .javaDependencies()


You can now remove the gradleSupportedModule() and gradleSupportedModuleBuilder since we a feature parity between maven and gradle for build profile, in order to have only one module() method.

murdos · 2024-03-26T21:11:39Z

...hipster/lite/module/infrastructure/secondary/javadependency/gradle/GradleCommandHandler.java

    );
  }

+  private String projectFolderRelativePathFrom(Path buildGradleFile) {


How about returning directly a JHipsterProjectFilePath? You seem to always use this method that way

Suggested change

private String projectFolderRelativePathFrom(Path buildGradleFile) {

private JHipsterProjectFilePath projectFolderRelativePathFrom(Path buildGradleFile) {

return new JHipsterProjectFilePath(Path.of(projectFolder.folder()).relativize(buildGradleFile).toString());

Sure! Nice 👍

murdos · 2024-03-26T21:14:06Z

...hipster/lite/module/infrastructure/secondary/javadependency/gradle/GradleCommandHandler.java

@@ -330,6 +367,10 @@ private void enablePrecompiledScriptPlugins() {
    addFileToProject(from("buildtool/gradle/buildSrc/build.gradle.kts.template"), to("buildSrc/build.gradle.kts"));
  }

+  private void injectTomlVersionCatalogLibsIntoScriptPlugins() {


The method name is a bit misleading (you're rather initiating settings.gradle for precompiled script plugins), and I think you should rather add this addFileToProject(..) statement directly in enablePrecompiledScriptPlugins()

Thanks! Yes, It is part of the PrecompiledScript prerequisites to work properly 😃

murdos · 2024-03-26T21:22:36Z

...hipster/lite/module/infrastructure/secondary/javadependency/gradle/GradleCommandHandler.java

+  }
+
+  @ExcludeFromGeneratedCodeCoverage(reason = "The exception handling is hard to test and an implementation detail")
+  private boolean dependencyExistsFrom(DependencySlug dependencySlug, Optional<BuildProfileId> buildProfile) {


It would be nicer to use and read with the following signature:

Suggested change

private boolean dependencyExistsFrom(DependencySlug dependencySlug, Optional<BuildProfileId> buildProfile) {

private Predicate<DependencySlug> dependencyExistsFrom(Optional<BuildProfileId> buildProfile) {

return dependencySlug -> {

try {

return dependencyLinePattern(dependencySlug, buildProfile).matcher(Files.readString(buildGradleFile(buildProfile))).find();

} catch (IOException e) {

throw GeneratorException.technicalError("Error reading build gradle file: " + e.getMessage(), e);

}

};

}

That way you could use it as .filter(dependencyExistsFrom(command.buildProfile()))

Thanks! I have to do this more often 👍

…t from gradle profile

…ethod logic

renanfranca · 2024-03-27T12:04:06Z

@murdos : the code coverage wasnt 100% because the annotation @ExcludeFromGeneratedCodeCoverage doesn't work for the following method as expected. Did you encounter this situation before?

Thanks for the detailed review! 😁🖖

murdos · 2024-03-27T12:24:44Z

@renanfranca : it works for the method, but not for the lambda that is inside the method.
There's currently no way to tell jacoco to exclude a lambda from coverage calculation 😅

renanfranca · 2024-03-27T13:16:42Z

There's currently no way to tell jacoco to exclude a lambda from coverage calculation 😅

@murdos: I implemented this fix:

  private Predicate<DependencySlug> dependencyExistsFrom(Optional<BuildProfileId> buildProfile) {
    return dependencySlug -> dependencyExistsFrom(dependencySlug, buildProfile);
  }

  @ExcludeFromGeneratedCodeCoverage(reason = "The exception handling is hard to test and an implementation detail")
  private boolean dependencyExistsFrom(DependencySlug dependencySlug, Optional<BuildProfileId> buildProfile) {
    try {
      return dependencyLinePattern(dependencySlug, buildProfile).matcher(Files.readString(buildGradleFile(buildProfile))).find();
    } catch (IOException e) {
      throw GeneratorException.technicalError("Error reading build gradle file: " + e.getMessage(), e);
    }
  }

murdos · 2024-03-27T13:37:24Z

Great work, again @renanfranca ! Thanks!!!

renanfranca · 2024-03-27T13:55:11Z

Great work, again @renanfranca ! Thanks!!!

You are welcome! Thank you for the kind words 😄

renanfranca added area: feature request 💡 theme: gradle labels Mar 26, 2024

renanfranca self-assigned this Mar 26, 2024

renanfranca mentioned this pull request Mar 26, 2024

Support java build profile in gradle #8627

Closed

4 tasks

renanfranca requested a review from murdos March 26, 2024 16:45

murdos reviewed Mar 26, 2024

View reviewed changes

murdos previously approved these changes Mar 26, 2024

View reviewed changes

renanfranca added 8 commits March 27, 2024 07:38

support AddDirectJavaDependency to gradle profile

0387a2f

support RemoveDirectJavaDependency from gradle profile

91a18bf

support AddJavaDependencyManagement and RemoveJavaDependencyManagemen…

fff5846

…t from gradle profile

replace Optional as parameter because it values was not used by the m…

5861531

…ethod logic

improve code readability by return Predicate at the filter method

f554548

merge methods with the same goal

e35b46e

improve method utility by incorporate responsibility

1731839

unify module features used to test maven and gradle

2c55be6

renanfranca dismissed murdos’s stale review via 2c55be6 March 27, 2024 11:23

renanfranca force-pushed the support-dependencies-and-dependencies-management-in-a-build-profile branch from dec8875 to 2c55be6 Compare March 27, 2024 11:23

fix the use of the @ExcludeFromGeneratedCodeCoverage annotation

6d847d4

murdos merged commit 8e2c907 into jhipster:main Mar 27, 2024
37 checks passed

renanfranca deleted the support-dependencies-and-dependencies-management-in-a-build-profile branch March 27, 2024 14:14

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

support dependencies and dependencies management in a build profile #9369

support dependencies and dependencies management in a build profile #9369

renanfranca commented Mar 26, 2024

codecov bot commented Mar 26, 2024 •

edited

murdos Mar 26, 2024

murdos Mar 26, 2024

murdos Mar 26, 2024

murdos Mar 26, 2024

renanfranca Mar 27, 2024

murdos Mar 26, 2024

renanfranca Mar 27, 2024

murdos Mar 26, 2024

renanfranca Mar 27, 2024

renanfranca commented Mar 27, 2024 •

edited

murdos commented Mar 27, 2024

renanfranca commented Mar 27, 2024

murdos commented Mar 27, 2024

renanfranca commented Mar 27, 2024

	if (dependency.scope() == JavaDependencyScope.IMPORT) {
	var versionCatalogReference = forBuildProfile ? versionCatalogReferenceForBuildProfile(dependency) : versionCatalogReference(dependency);
	if (dependency.scope() == JavaDependencyScope.IMPORT) {

	private String dependencyDeclaration(JavaDependency dependency, Optional<BuildProfileId> buildProfile) {
	private String dependencyDeclaration(JavaDependency dependency, boolean forBuildProfile) {

	private String projectFolderRelativePathFrom(Path buildGradleFile) {
	private JHipsterProjectFilePath projectFolderRelativePathFrom(Path buildGradleFile) {
	return new JHipsterProjectFilePath(Path.of(projectFolder.folder()).relativize(buildGradleFile).toString());

support dependencies and dependencies management in a build profile #9369

support dependencies and dependencies management in a build profile #9369

Conversation

renanfranca commented Mar 26, 2024

codecov bot commented Mar 26, 2024 • edited

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

renanfranca commented Mar 27, 2024 • edited

murdos commented Mar 27, 2024

renanfranca commented Mar 27, 2024

murdos commented Mar 27, 2024

renanfranca commented Mar 27, 2024

codecov bot commented Mar 26, 2024 •

edited

renanfranca commented Mar 27, 2024 •

edited