mirror of https://github.com/apache/maven.git
[MNG-7967] Verify javadoc:jar is invoked (#324)
It uses javadoc:jar goal from locked-down version of Javadoc plugin: Bug is that it refuses to run as 4-alpha-9 returns here language="none". If it would run, it would explode, as project contains java source with intentionally broken javadoc. --- https://issues.apache.org/jira/browse/MNG-7967
This commit is contained in:
parent
fff02a9ec3
commit
ac8874e8f6
|
@ -0,0 +1,77 @@
|
|||
/*
|
||||
* Licensed to the Apache Software Foundation (ASF) under one
|
||||
* or more contributor license agreements. See the NOTICE file
|
||||
* distributed with this work for additional information
|
||||
* regarding copyright ownership. The ASF licenses this file
|
||||
* to you 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
|
||||
*
|
||||
* http://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.
|
||||
*/
|
||||
package org.apache.maven.it;
|
||||
|
||||
import java.io.File;
|
||||
import java.util.List;
|
||||
|
||||
import org.apache.maven.shared.verifier.VerificationException;
|
||||
import org.apache.maven.shared.verifier.Verifier;
|
||||
import org.apache.maven.shared.verifier.util.ResourceExtractor;
|
||||
import org.junit.jupiter.api.Test;
|
||||
|
||||
/**
|
||||
* This is a test set for
|
||||
* <a href="https://issues.apache.org/jira/browse/MNG-7967">MNG-7967</a>.
|
||||
* Allow to exclude plugins from validation. Affected is Maven 4.0.0-alpha-9.
|
||||
*/
|
||||
class MavenITmng7967ArtifactHandlerLanguageTest extends AbstractMavenIntegrationTestCase {
|
||||
|
||||
protected MavenITmng7967ArtifactHandlerLanguageTest() {
|
||||
super("(,4.0.0-alpha-9),(4.0.0-alpha-9,)");
|
||||
}
|
||||
|
||||
@Test
|
||||
void javadocIsExecutedAndFailed() throws Exception {
|
||||
File testDir = ResourceExtractor.simpleExtractResources(getClass(), "/mng-7967-artifact-handler-language");
|
||||
|
||||
Verifier verifier = newVerifier(testDir.getAbsolutePath());
|
||||
verifier.deleteDirectory("target");
|
||||
verifier.addCliArgument("org.apache.maven.plugins:maven-javadoc-plugin:3.6.3:jar");
|
||||
|
||||
boolean invocationFailed = false;
|
||||
// whatever outcome we do not fail here, but later
|
||||
try {
|
||||
verifier.execute();
|
||||
} catch (VerificationException e) {
|
||||
invocationFailed = true;
|
||||
}
|
||||
|
||||
List<String> logs = verifier.loadLines(verifier.getLogFileName(), null);
|
||||
|
||||
// javadoc:jar uses language to detect is this "Java classpath-capable package"
|
||||
verifyTextNotInLog(logs, "[INFO] Not executing Javadoc as the project is not a Java classpath-capable package");
|
||||
|
||||
// javadoc invocation should actually fail the build
|
||||
verifyTextInLog(logs, "[INFO] BUILD FAILURE");
|
||||
|
||||
// javadoc invocation should actually fail the build
|
||||
verifyTextInLog(logs, "[ERROR] Failed to execute goal org.apache.maven.plugins:maven-javadoc-plugin");
|
||||
|
||||
assertTrue("The Maven invocation should have failed: the javadoc should error out", invocationFailed);
|
||||
}
|
||||
|
||||
private void verifyTextInLog(List<String> logs, String text) {
|
||||
assertTrue("Log file not contains: " + text, logs.stream().anyMatch(l -> l.contains(text)));
|
||||
}
|
||||
|
||||
private void verifyTextNotInLog(List<String> logs, String text) {
|
||||
assertFalse("Log file contains: " + text, logs.stream().anyMatch(l -> l.contains(text)));
|
||||
}
|
||||
}
|
|
@ -120,6 +120,7 @@ public class TestSuiteOrdering implements ClassOrderer {
|
|||
* the tests are to finishing. Newer tests are also more likely to fail, so this is
|
||||
* a fail fast technique as well.
|
||||
*/
|
||||
suite.addTestSuite(MavenITmng7967ArtifactHandlerLanguageTest.class);
|
||||
suite.addTestSuite(MavenITmng7965PomDuplicateTagsTest.class);
|
||||
suite.addTestSuite(MavenITmng7939PluginsValidationExcludesTest.class);
|
||||
suite.addTestSuite(MavenITmng7837ProjectElementInPomTest.class);
|
||||
|
|
|
@ -98,6 +98,7 @@ org.apache.maven.plugins:maven-install-plugin:3.0.1
|
|||
org.apache.maven.plugins:maven-jar-plugin:${stubPluginVersion}
|
||||
org.apache.maven.plugins:maven-jar-plugin:3.3.0
|
||||
org.apache.maven.plugins:maven-javadoc-plugin:${stubPluginVersion}
|
||||
org.apache.maven.plugins:maven-javadoc-plugin:3.6.3
|
||||
org.apache.maven.plugins:maven-plugin-plugin:${stubPluginVersion}
|
||||
org.apache.maven.plugins:maven-plugin-plugin:3.2
|
||||
org.apache.maven.plugins:maven-plugin-plugin:3.3
|
||||
|
|
|
@ -0,0 +1,27 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!--
|
||||
Licensed to the Apache Software Foundation (ASF) under one
|
||||
or more contributor license agreements. See the NOTICE file
|
||||
distributed with this work for additional information
|
||||
regarding copyright ownership. The ASF licenses this file
|
||||
to you 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
|
||||
|
||||
http://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.
|
||||
-->
|
||||
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
|
||||
<modelVersion>4.0.0</modelVersion>
|
||||
|
||||
<groupId>org.apache.maven.its.mng7967</groupId>
|
||||
<artifactId>test</artifactId>
|
||||
<version>1.0.0-SNAPSHOT</version>
|
||||
|
||||
</project>
|
|
@ -0,0 +1,35 @@
|
|||
/*
|
||||
* Licensed to the Apache Software Foundation (ASF) under one
|
||||
* or more contributor license agreements. See the NOTICE file
|
||||
* distributed with this work for additional information
|
||||
* regarding copyright ownership. The ASF licenses this file
|
||||
* to you 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
|
||||
*
|
||||
* http://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.
|
||||
*/
|
||||
package org.apache.maven.its.mng7967;
|
||||
|
||||
/**
|
||||
* This is a sample class with intentionally broken javadoc on method.
|
||||
*/
|
||||
public class Sample {
|
||||
|
||||
/**
|
||||
* Hello world method, with intentionally broken javadoc, the params are off.
|
||||
*
|
||||
* @param where The where is not where but who, is here to fail Javadoc.
|
||||
* @return The "Hello" string.
|
||||
*/
|
||||
public String helloWorld(String who) {
|
||||
return "Hello!";
|
||||
}
|
||||
}
|
Loading…
Reference in New Issue