This is an automated email from the ASF dual-hosted git repository. elharo pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/maven-enforcer.git
The following commit(s) were added to refs/heads/master by this push: new 0912674 A grabbag of small simplifications found by IntelliJ (#354) 0912674 is described below commit 091267439a0df77d5e2bc8772f8a9685eacf2714 Author: Elliotte Rusty Harold <elh...@users.noreply.github.com> AuthorDate: Sat Feb 22 22:04:55 2025 +0000 A grabbag of small simplifications found by IntelliJ (#354) --- .../rules/BanDependencyManagementScope.java | 2 +- .../maven/enforcer/rules/BannedRepositories.java | 8 +++--- .../apache/maven/enforcer/rules/ExternalRules.java | 2 +- .../enforcer/rules/ReactorModuleConvergence.java | 6 ++--- .../enforcer/rules/RequirePluginVersions.java | 8 +++--- .../rules/dependency/BanDynamicVersions.java | 29 ++++++++-------------- .../enforcer/rules/files/RequireFilesExist.java | 11 +++----- .../enforcer/rules/utils/ArtifactMatcher.java | 4 +-- .../enforcer/rules/version/RequireJavaVersion.java | 2 +- .../rules/BanDistributionManagementTest.java | 18 ++++++-------- .../maven/enforcer/rules/TestAlwaysPass.java | 3 +-- .../enforcer/rules/TestRequireJavaVendor.java | 2 +- .../enforcer/rules/TestRequirePluginVersions.java | 2 +- .../enforcer/rules/utils/TestArtifactMatcher.java | 3 +-- .../rules/version/TestAbstractVersionEnforcer.java | 9 ++----- .../apache/maven/plugins/enforcer/EnforceMojo.java | 9 +++---- 16 files changed, 48 insertions(+), 70 deletions(-) diff --git a/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/BanDependencyManagementScope.java b/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/BanDependencyManagementScope.java index ed8848d..0be93eb 100644 --- a/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/BanDependencyManagementScope.java +++ b/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/BanDependencyManagementScope.java @@ -85,7 +85,7 @@ public final class BanDependencyManagementScope extends AbstractStandardEnforcer } } - protected List<Dependency> getViolatingDependencies(DependencyManagement depMgmt) { + List<Dependency> getViolatingDependencies(DependencyManagement depMgmt) { final ArtifactMatcher excludesMatcher; if (excludes != null) { excludesMatcher = new ArtifactMatcher(excludes, Collections.emptyList()); diff --git a/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/BannedRepositories.java b/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/BannedRepositories.java index cff0840..4b67f91 100644 --- a/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/BannedRepositories.java +++ b/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/BannedRepositories.java @@ -96,18 +96,18 @@ public final class BannedRepositories extends AbstractStandardEnforcerRule { } // ---------------------------------------------------------------------- - // Protected methods + // Package methods // ---------------------------------------------------------------------- - protected void setBannedRepositories(List<String> bannedRepositories) { + void setBannedRepositories(List<String> bannedRepositories) { this.bannedRepositories = bannedRepositories; } - protected void setAllowedRepositories(List<String> allowedRepositories) { + void setAllowedRepositories(List<String> allowedRepositories) { this.allowedRepositories = allowedRepositories; } - protected void setAllowedPluginRepositories(List<String> allowedPluginRepositories) { + void setAllowedPluginRepositories(List<String> allowedPluginRepositories) { this.allowedPluginRepositories = allowedPluginRepositories; } diff --git a/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/ExternalRules.java b/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/ExternalRules.java index 52dd8f2..540024b 100644 --- a/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/ExternalRules.java +++ b/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/ExternalRules.java @@ -200,7 +200,7 @@ public final class ExternalRules extends AbstractEnforcerRuleConfigProvider { Transformer transformer = TransformerFactory.newInstance().newTransformer(new StreamSource(in)); transformer.transform(new StreamSource(sourceXml), new StreamResult(baos)); final byte[] bytes = baos.toByteArray(); - getLog().info(() -> (CharSequence) ("Rules transformed by " + xsltLocation + " from " + location + ":\n\n" + getLog().info(() -> ("Rules transformed by " + xsltLocation + " from " + location + ":\n\n" + new String(bytes, StandardCharsets.UTF_8))); return new ByteArrayInputStream(bytes); } catch (IOException diff --git a/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/ReactorModuleConvergence.java b/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/ReactorModuleConvergence.java index 090b056..afceb8e 100644 --- a/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/ReactorModuleConvergence.java +++ b/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/ReactorModuleConvergence.java @@ -307,9 +307,9 @@ public final class ReactorModuleConvergence extends AbstractStandardEnforcerRule * dependency based on groupId/artifactId if it belongs to the multi module build. In such a case it will be checked * if the version does fit the version in the rest of build. * - * @param reactorVersion The version of the reactor. - * @param sortedProjects The list of existing projects within this build. - * @return List of violations. Never null. If the list is empty than no violation has happened. + * @param reactorVersion the version of the reactor + * @param sortedProjects the list of existing projects within this build + * @return map of violations. Never null. If the map is empty, then no violation has happened. */ // CHECKSTYLE_OFF: LineLength private Map<MavenProject, List<Dependency>> areThereDependenciesWhichAreNotPartOfTheReactor( diff --git a/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/RequirePluginVersions.java b/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/RequirePluginVersions.java index 8c4e209..324749a 100644 --- a/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/RequirePluginVersions.java +++ b/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/RequirePluginVersions.java @@ -608,7 +608,7 @@ public final class RequirePluginVersions extends AbstractStandardEnforcerRule { for (Map.Entry<String, String> entry : mappings.entrySet()) { getLog().debug(" lifecycleMapping = " + entry.getKey()); - String pluginsForLifecycle = (String) entry.getValue(); + String pluginsForLifecycle = entry.getValue(); getLog().debug(" plugins = " + pluginsForLifecycle); if (pluginsForLifecycle != null && !pluginsForLifecycle.isEmpty()) { String pluginList[] = pluginsForLifecycle.split(","); @@ -651,7 +651,7 @@ public final class RequirePluginVersions extends AbstractStandardEnforcerRule { for (String phase : phases) { getLog().debug("getPhaseToLifecycleMap(): phase: " + phase); if (phaseToLifecycleMap.containsKey(phase)) { - Lifecycle prevLifecycle = (Lifecycle) phaseToLifecycleMap.get(phase); + Lifecycle prevLifecycle = phaseToLifecycleMap.get(phase); throw new LifecycleExecutionException("Phase '" + phase + "' is defined in more than one lifecycle: '" + lifecycle.getId() + "' and '" + prevLifecycle.getId() + "'"); @@ -710,7 +710,7 @@ public final class RequirePluginVersions extends AbstractStandardEnforcerRule { } catch (ComponentLookupException e) { if (defaultMappings == null) { throw new LifecycleExecutionException( - "Cannot find lifecycle mapping for packaging: \'" + packaging + "\'.", e); + "Cannot find lifecycle mapping for packaging: '" + packaging + "'.", e); } } } @@ -718,7 +718,7 @@ public final class RequirePluginVersions extends AbstractStandardEnforcerRule { if (mappings == null) { if (defaultMappings == null) { throw new LifecycleExecutionException( - "Cannot find lifecycle mapping for packaging: \'" + packaging + "\', and there is no default"); + "Cannot find lifecycle mapping for packaging: '" + packaging + "', and there is no default"); } else { mappings = defaultMappings; } diff --git a/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/dependency/BanDynamicVersions.java b/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/dependency/BanDynamicVersions.java index 1aa10ff..49f3fa2 100644 --- a/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/dependency/BanDynamicVersions.java +++ b/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/dependency/BanDynamicVersions.java @@ -37,7 +37,6 @@ import org.apache.maven.enforcer.rules.utils.ArtifactUtils; import org.apache.maven.execution.MavenSession; import org.apache.maven.project.MavenProject; import org.eclipse.aether.RepositorySystem; -import org.eclipse.aether.collection.DependencyCollectionException; import org.eclipse.aether.graph.DependencyFilter; import org.eclipse.aether.graph.DependencyNode; import org.eclipse.aether.util.graph.manager.DependencyManagerUtils; @@ -221,21 +220,16 @@ public final class BanDynamicVersions extends AbstractStandardEnforcerRule { @Override public void execute() throws EnforcerRuleException { - - try { - DependencyNode rootDependency = - resolverUtil.resolveTransitiveDependencies(verbose, excludeOptionals, excludedScopes); - - List<String> violations = collectDependenciesWithBannedDynamicVersions(rootDependency); - if (!violations.isEmpty()) { - ChoiceFormat dependenciesFormat = new ChoiceFormat("1#dependency|1<dependencies"); - throw new EnforcerRuleException("Found " + violations.size() + " " - + dependenciesFormat.format(violations.size()) - + " with dynamic versions." + System.lineSeparator() - + String.join(System.lineSeparator(), violations)); - } - } catch (DependencyCollectionException e) { - throw new EnforcerRuleException("Could not retrieve dependency metadata for project", e); + DependencyNode rootDependency = + resolverUtil.resolveTransitiveDependencies(verbose, excludeOptionals, excludedScopes); + + List<String> violations = collectDependenciesWithBannedDynamicVersions(rootDependency); + if (!violations.isEmpty()) { + ChoiceFormat dependenciesFormat = new ChoiceFormat("1#dependency|1<dependencies"); + throw new EnforcerRuleException("Found " + violations.size() + " " + + dependenciesFormat.format(violations.size()) + + " with dynamic versions." + System.lineSeparator() + + String.join(System.lineSeparator(), violations)); } } @@ -260,8 +254,7 @@ public final class BanDynamicVersions extends AbstractStandardEnforcerRule { } } - private List<String> collectDependenciesWithBannedDynamicVersions(DependencyNode rootDependency) - throws DependencyCollectionException { + private List<String> collectDependenciesWithBannedDynamicVersions(DependencyNode rootDependency) { Predicate<DependencyNode> predicate; if (ignores != null && !ignores.isEmpty()) { predicate = new ExcludeArtifactPatternsPredicate(ignores); diff --git a/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/files/RequireFilesExist.java b/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/files/RequireFilesExist.java index 9318dbc..265cf25 100644 --- a/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/files/RequireFilesExist.java +++ b/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/files/RequireFilesExist.java @@ -31,7 +31,7 @@ public final class RequireFilesExist extends AbstractRequireFiles { @Override boolean checkFile(File file) { // if we get here and the handle is null, treat it as a success - return file == null ? true : file.exists() && osIndependentNameMatch(file, true); + return file == null ? true : file.exists() && osIndependentNameMatch(file); } @Override @@ -40,15 +40,12 @@ public final class RequireFilesExist extends AbstractRequireFiles { } /** - * OSes like Windows are case insensitive, so this method will compare the file path with the actual path. A simple + * OSes like Windows are case-insensitive, so this method will compare the file path with the actual path. A simple * {@link File#exists()} is not enough for such OS. * * @param file the file to verify - * @param defaultValue value to return in case an IO exception occurs, should never happen as the file already - * exists - * @return */ - private boolean osIndependentNameMatch(File file, boolean defaultValue) { + private boolean osIndependentNameMatch(File file) { try { File absFile; if (!file.isAbsolute()) { @@ -59,7 +56,7 @@ public final class RequireFilesExist extends AbstractRequireFiles { return absFile.toURI().equals(absFile.getCanonicalFile().toURI()); } catch (IOException e) { - return defaultValue; + return true; } } } diff --git a/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/utils/ArtifactMatcher.java b/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/utils/ArtifactMatcher.java index 0f2d774..55d4775 100644 --- a/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/utils/ArtifactMatcher.java +++ b/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/utils/ArtifactMatcher.java @@ -107,7 +107,7 @@ public final class ArtifactMatcher { return false; } case 5: - if (scope == null || scope.equals("")) { + if (scope == null || scope.isEmpty()) { scope = Artifact.SCOPE_COMPILE; } @@ -115,7 +115,7 @@ public final class ArtifactMatcher { return false; } case 4: - if (type == null || type.equals("")) { + if (type == null || type.isEmpty()) { type = "jar"; } diff --git a/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/version/RequireJavaVersion.java b/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/version/RequireJavaVersion.java index ca5fcf3..657ed54 100644 --- a/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/version/RequireJavaVersion.java +++ b/enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/version/RequireJavaVersion.java @@ -119,7 +119,7 @@ public final class RequireJavaVersion extends AbstractVersionEnforcer { String section = iter.next(); section = section.replaceAll("[^0-9]", ""); - if (section != null && !section.isEmpty()) { + if (!section.isEmpty()) { buffer.append(Integer.parseInt(section)); if (i != 2) { diff --git a/enforcer-rules/src/test/java/org/apache/maven/enforcer/rules/BanDistributionManagementTest.java b/enforcer-rules/src/test/java/org/apache/maven/enforcer/rules/BanDistributionManagementTest.java index 210b4d1..4cf1ad5 100644 --- a/enforcer-rules/src/test/java/org/apache/maven/enforcer/rules/BanDistributionManagementTest.java +++ b/enforcer-rules/src/test/java/org/apache/maven/enforcer/rules/BanDistributionManagementTest.java @@ -23,7 +23,6 @@ import org.apache.maven.enforcer.rule.api.EnforcerRuleException; import org.apache.maven.model.DeploymentRepository; import org.apache.maven.model.DistributionManagement; import org.apache.maven.model.Model; -import org.apache.maven.model.Site; import org.apache.maven.project.MavenProject; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; @@ -76,7 +75,7 @@ class BanDistributionManagementTest { */ @Test void shouldThrowExceptionIfDistributionManagementIsDefinedWithRepository() { - setupProjectWithDistributionManagement(new DeploymentRepository(), null, null); + setupProjectWithDistributionManagement(new DeploymentRepository(), null); assertThrows(EnforcerRuleException.class, () -> rule.execute()); } @@ -91,7 +90,7 @@ class BanDistributionManagementTest { */ @Test void shouldThrowExceptionIfDistributionManagementIsDefinedWithRepositorySnapshotRepository() { - setupProjectWithDistributionManagement(null, new DeploymentRepository(), null); + setupProjectWithDistributionManagement(null, new DeploymentRepository()); assertThrows(EnforcerRuleException.class, () -> rule.execute()); } @@ -113,7 +112,7 @@ class BanDistributionManagementTest { */ @Test void shouldThrowExceptionIfDistributionManagementIsDefinedWithRepositorySnapshotRepositorySite() { - setupProjectWithDistributionManagement(new DeploymentRepository(), null, null); + setupProjectWithDistributionManagement(new DeploymentRepository(), null); assertThrows(EnforcerRuleException.class, () -> rule.execute()); } @@ -131,7 +130,7 @@ class BanDistributionManagementTest { */ @Test void shouldAllowDistributionManagementHavingRepository() throws Exception { - setupProjectWithDistributionManagement(null, null, null); + setupProjectWithDistributionManagement(null, null); rule.setAllowRepository(true); rule.execute(); // intentionally no assert cause in case of an exception the test will be red. @@ -153,7 +152,7 @@ class BanDistributionManagementTest { */ @Test void shouldAllowDistributionManagementHavingRepositorySnapshotRepository() throws Exception { - setupProjectWithDistributionManagement(null, null, null); + setupProjectWithDistributionManagement(null, null); rule.setAllowRepository(true); rule.setAllowSnapshotRepository(true); @@ -180,7 +179,7 @@ class BanDistributionManagementTest { */ @Test void shouldAllowDistributionManagementHavingRepositorySnapshotRepositorySite() throws Exception { - setupProjectWithDistributionManagement(null, null, null); + setupProjectWithDistributionManagement(null, null); rule.setAllowRepository(true); rule.setAllowSnapshotRepository(true); rule.setAllowSite(true); @@ -193,7 +192,7 @@ class BanDistributionManagementTest { } private void setupProjectWithDistributionManagement( - DeploymentRepository repository, DeploymentRepository snapshotRepository, Site site) { + DeploymentRepository repository, DeploymentRepository snapshotRepository) { DistributionManagement dm = mock(DistributionManagement.class); if (repository != null) { when(dm.getRepository()).thenReturn(repository); @@ -201,9 +200,6 @@ class BanDistributionManagementTest { if (snapshotRepository != null) { when(dm.getSnapshotRepository()).thenReturn(snapshotRepository); } - if (site != null) { - when(dm.getSite()).thenReturn(site); - } setupProject(dm); when(project.getParent()).thenReturn(mock(MavenProject.class)); diff --git a/enforcer-rules/src/test/java/org/apache/maven/enforcer/rules/TestAlwaysPass.java b/enforcer-rules/src/test/java/org/apache/maven/enforcer/rules/TestAlwaysPass.java index f4e0cff..6f80fc6 100644 --- a/enforcer-rules/src/test/java/org/apache/maven/enforcer/rules/TestAlwaysPass.java +++ b/enforcer-rules/src/test/java/org/apache/maven/enforcer/rules/TestAlwaysPass.java @@ -19,7 +19,6 @@ package org.apache.maven.enforcer.rules; import org.apache.maven.enforcer.rule.api.EnforcerLogger; -import org.apache.maven.enforcer.rule.api.EnforcerRuleException; import org.junit.jupiter.api.Test; import static org.assertj.core.api.Assertions.assertThatCode; @@ -34,7 +33,7 @@ import static org.mockito.Mockito.mock; class TestAlwaysPass { @Test - void testExecute() throws EnforcerRuleException { + void testExecute() { AlwaysPass rule = new AlwaysPass(); rule.setLog(mock(EnforcerLogger.class)); diff --git a/enforcer-rules/src/test/java/org/apache/maven/enforcer/rules/TestRequireJavaVendor.java b/enforcer-rules/src/test/java/org/apache/maven/enforcer/rules/TestRequireJavaVendor.java index 93dbe9c..12f7b09 100644 --- a/enforcer-rules/src/test/java/org/apache/maven/enforcer/rules/TestRequireJavaVendor.java +++ b/enforcer-rules/src/test/java/org/apache/maven/enforcer/rules/TestRequireJavaVendor.java @@ -45,7 +45,7 @@ class TestRequireJavaVendor { } @Test - void matchingInclude() throws EnforcerRuleException { + void matchingInclude() { // Set the required vendor to the current system vendor underTest.setIncludes(Collections.singletonList(SystemUtils.JAVA_VENDOR)); diff --git a/enforcer-rules/src/test/java/org/apache/maven/enforcer/rules/TestRequirePluginVersions.java b/enforcer-rules/src/test/java/org/apache/maven/enforcer/rules/TestRequirePluginVersions.java index 155c65b..8f19cba 100644 --- a/enforcer-rules/src/test/java/org/apache/maven/enforcer/rules/TestRequirePluginVersions.java +++ b/enforcer-rules/src/test/java/org/apache/maven/enforcer/rules/TestRequirePluginVersions.java @@ -477,7 +477,7 @@ class TestRequirePluginVersions { * * @param group the group * @param artifact the artifact - * @param theSet the the set + * @param theSet the set */ private void assertContainsPlugin(String group, String artifact, Collection<Plugin> theSet) { Plugin p = new Plugin(); diff --git a/enforcer-rules/src/test/java/org/apache/maven/enforcer/rules/utils/TestArtifactMatcher.java b/enforcer-rules/src/test/java/org/apache/maven/enforcer/rules/utils/TestArtifactMatcher.java index 8486e8a..e0a6b55 100644 --- a/enforcer-rules/src/test/java/org/apache/maven/enforcer/rules/utils/TestArtifactMatcher.java +++ b/enforcer-rules/src/test/java/org/apache/maven/enforcer/rules/utils/TestArtifactMatcher.java @@ -132,8 +132,7 @@ class TestArtifactMatcher { final String versionRange, final String scope, final String type, - boolean expectedResult) - throws InvalidVersionSpecificationException { + boolean expectedResult) { executePatternMatch(pattern, groupId, artifactId, versionRange, scope, type, "", expectedResult); } diff --git a/enforcer-rules/src/test/java/org/apache/maven/enforcer/rules/version/TestAbstractVersionEnforcer.java b/enforcer-rules/src/test/java/org/apache/maven/enforcer/rules/version/TestAbstractVersionEnforcer.java index 0bfa859..4e7ab7d 100644 --- a/enforcer-rules/src/test/java/org/apache/maven/enforcer/rules/version/TestAbstractVersionEnforcer.java +++ b/enforcer-rules/src/test/java/org/apache/maven/enforcer/rules/version/TestAbstractVersionEnforcer.java @@ -46,13 +46,8 @@ class TestAbstractVersionEnforcer { try { rule.enforceVersion(var, range, version); fail("Expected to receive EnforcerRuleException because:" + version + " is not contained by " + range); - } catch (Exception e) { - if (e instanceof EnforcerRuleException) { - // log.info( "Caught Expected Exception: " + - // e.getLocalizedMessage() ); - } else { - fail("Received wrong exception. Expected EnforcerRuleExeption. Received:" + e); - } + } catch (EnforcerRuleException expected) { + // success } } diff --git a/maven-enforcer-plugin/src/main/java/org/apache/maven/plugins/enforcer/EnforceMojo.java b/maven-enforcer-plugin/src/main/java/org/apache/maven/plugins/enforcer/EnforceMojo.java index bbd3b81..4f2eb79 100644 --- a/maven-enforcer-plugin/src/main/java/org/apache/maven/plugins/enforcer/EnforceMojo.java +++ b/maven-enforcer-plugin/src/main/java/org/apache/maven/plugins/enforcer/EnforceMojo.java @@ -298,15 +298,14 @@ public class EnforceMojo extends AbstractMojo { getLog().debug(String.format("Executing Rule Config Provider %s", ruleDesc.getRule())); } - XmlPlexusConfiguration configuration = null; try { - configuration = new XmlPlexusConfiguration(ruleProducer.getRulesConfig()); + XmlPlexusConfiguration configuration = new XmlPlexusConfiguration(ruleProducer.getRulesConfig()); + getLog().info(String.format("Rule Config Provider %s executed", getRuleName(ruleDesc))); + + return configuration; } catch (EnforcerRuleException e) { throw new EnforcerRuleManagerException("Rules Provider error for: " + getRuleName(ruleDesc), e); } - getLog().info(String.format("Rule Config Provider %s executed", getRuleName(ruleDesc))); - - return configuration; } private void executeRule(int ruleIndex, EnforcerRuleDesc ruleDesc, EnforcerRuleHelper helper)