use of org.apache.maven.execution.MavenSession in project karaf by apache.
the class DependencyHelperFactory method createDependencyHelper.
/**
* <p>Create a new {@link DependencyHelper} based on what has been found in {@link org.codehaus.plexus.PlexusContainer}</p>
*
* <p>{@code karaf-maven-plugin} depends on {@code maven-core:3.0}, so for Maven 3.0.x, it may use this API directly.
* When using Maven 3.1.x/3.2.x, it should use reflection to invoke org.apache.maven.RepositoryUtils.toArtifact(Artifact)
* as this method directly references specific Aether implementation.</p>
*
* <p>When {@code karaf-maven-plugin} switches to {@code maven-core:3.1.0+}, reflection should be use for Sonatype variant of Aether.</p>
*
* @param container The Maven Plexus container to use.
* @param mavenProject The Maven project to use.
* @param mavenSession The Maven session.
* @param log The log to use for the messages.
* @return The {@link DependencyHelper} depending of the Maven version used.
* @throws MojoExecutionException If the plugin execution fails.
*/
public static DependencyHelper createDependencyHelper(PlexusContainer container, MavenProject mavenProject, MavenSession mavenSession, Log log) throws MojoExecutionException {
try {
if (container.hasComponent("org.sonatype.aether.RepositorySystem")) {
org.sonatype.aether.RepositorySystem system = container.lookup(org.sonatype.aether.RepositorySystem.class);
org.sonatype.aether.RepositorySystemSession session = mavenSession.getRepositorySession();
List<RemoteRepository> repositories = mavenProject.getRemoteProjectRepositories();
return new Dependency30Helper(repositories, session, system);
} else if (container.hasComponent("org.eclipse.aether.RepositorySystem")) {
org.eclipse.aether.RepositorySystem system = container.lookup(org.eclipse.aether.RepositorySystem.class);
Object session;
try {
session = MavenSession.class.getMethod("getRepositorySession").invoke(mavenSession);
} catch (Exception e) {
throw new MojoExecutionException(e.getMessage(), e);
}
List<?> repositories = mavenProject.getRemoteProjectRepositories();
return new Dependency31Helper(repositories, session, system);
}
} catch (ComponentLookupException e) {
throw new MojoExecutionException(e.getMessage(), e);
}
throw new MojoExecutionException("Cannot locate either org.sonatype.aether.RepositorySystem or org.eclipse.aether.RepositorySystem");
}
use of org.apache.maven.execution.MavenSession in project maven-plugins by apache.
the class JavadocReportTest method testTagletArtifacts.
/**
* Method to test the <code><tagletArtifacts/></code> parameter.
*
* @throws Exception if any
*/
public void testTagletArtifacts() throws Exception {
File testPom = new File(unit, "tagletArtifacts-test/tagletArtifacts-test-plugin-config.xml");
JavadocReport mojo = lookupMojo(testPom);
MavenSession session = spy(newMavenSession(mojo.project));
ProjectBuildingRequest buildingRequest = mock(ProjectBuildingRequest.class);
when(buildingRequest.getRemoteRepositories()).thenReturn(mojo.project.getRemoteArtifactRepositories());
when(session.getProjectBuildingRequest()).thenReturn(buildingRequest);
MavenRepositorySystemSession repositorySession = new MavenRepositorySystemSession();
repositorySession.setLocalRepositoryManager(new SimpleLocalRepositoryManager(localRepo));
when(buildingRequest.getRepositorySession()).thenReturn(repositorySession);
when(session.getRepositorySession()).thenReturn(repositorySession);
LegacySupport legacySupport = lookup(LegacySupport.class);
legacySupport.setSession(session);
setVariableValueToObject(mojo, "session", session);
mojo.execute();
File optionsFile = new File(mojo.getOutputDirectory(), "options");
assertTrue(optionsFile.exists());
String options = readFile(optionsFile);
// count -taglet
assertEquals(20, StringUtils.countMatches(options, LINE_SEPARATOR + "-taglet" + LINE_SEPARATOR));
assertTrue(options.contains("org.apache.maven.tools.plugin.javadoc.MojoAggregatorTypeTaglet"));
assertTrue(options.contains("org.apache.maven.tools.plugin.javadoc.MojoComponentFieldTaglet"));
assertTrue(options.contains("org.apache.maven.tools.plugin.javadoc.MojoConfiguratorTypeTaglet"));
assertTrue(options.contains("org.apache.maven.tools.plugin.javadoc.MojoExecuteTypeTaglet"));
assertTrue(options.contains("org.apache.maven.tools.plugin.javadoc.MojoExecutionStrategyTypeTaglet"));
assertTrue(options.contains("org.apache.maven.tools.plugin.javadoc.MojoGoalTypeTaglet"));
assertTrue(options.contains("org.apache.maven.tools.plugin.javadoc.MojoInheritByDefaultTypeTaglet"));
assertTrue(options.contains("org.apache.maven.tools.plugin.javadoc.MojoInstantiationStrategyTypeTaglet"));
assertTrue(options.contains("org.apache.maven.tools.plugin.javadoc.MojoParameterFieldTaglet"));
assertTrue(options.contains("org.apache.maven.tools.plugin.javadoc.MojoPhaseTypeTaglet"));
assertTrue(options.contains("org.apache.maven.tools.plugin.javadoc.MojoReadOnlyFieldTaglet"));
assertTrue(options.contains("org.apache.maven.tools.plugin.javadoc.MojoRequiredFieldTaglet"));
assertTrue(options.contains("org.apache.maven.tools.plugin.javadoc.MojoRequiresDependencyResolutionTypeTaglet"));
assertTrue(options.contains("org.apache.maven.tools.plugin.javadoc.MojoRequiresDirectInvocationTypeTaglet"));
assertTrue(options.contains("org.apache.maven.tools.plugin.javadoc.MojoRequiresOnLineTypeTaglet"));
assertTrue(options.contains("org.apache.maven.tools.plugin.javadoc.MojoRequiresProjectTypeTaglet"));
assertTrue(options.contains("org.apache.maven.tools.plugin.javadoc.MojoRequiresReportsTypeTaglet"));
assertTrue(options.contains("org.codehaus.plexus.javadoc.PlexusConfigurationTaglet"));
assertTrue(options.contains("org.codehaus.plexus.javadoc.PlexusRequirementTaglet"));
assertTrue(options.contains("org.codehaus.plexus.javadoc.PlexusComponentTaglet"));
}
use of org.apache.maven.execution.MavenSession in project maven-plugins by apache.
the class JavadocReportTest method testDoclets.
/**
* Method to test the doclet artifact configuration
*
* @throws Exception if any
*/
public void testDoclets() throws Exception {
// ----------------------------------------------------------------------
// doclet-test: check if the file generated by UmlGraph exists and if
// doclet path contains the UmlGraph artifact
// ----------------------------------------------------------------------
File testPom = new File(unit, "doclet-test/doclet-test-plugin-config.xml");
JavadocReport mojo = lookupMojo(testPom);
MavenSession session = spy(newMavenSession(mojo.project));
ProjectBuildingRequest buildingRequest = mock(ProjectBuildingRequest.class);
when(buildingRequest.getRemoteRepositories()).thenReturn(mojo.project.getRemoteArtifactRepositories());
when(session.getProjectBuildingRequest()).thenReturn(buildingRequest);
MavenRepositorySystemSession repositorySession = new MavenRepositorySystemSession();
repositorySession.setLocalRepositoryManager(new SimpleLocalRepositoryManager(localRepo));
when(buildingRequest.getRepositorySession()).thenReturn(repositorySession);
when(session.getRepositorySession()).thenReturn(repositorySession);
LegacySupport legacySupport = lookup(LegacySupport.class);
legacySupport.setSession(session);
setVariableValueToObject(mojo, "session", session);
mojo.execute();
File generatedFile = new File(getBasedir(), "target/test/unit/doclet-test/target/site/apidocs/graph.dot");
assertTrue(FileUtils.fileExists(generatedFile.getAbsolutePath()));
File optionsFile = new File(mojo.getOutputDirectory(), "options");
assertTrue(optionsFile.exists());
String options = readFile(optionsFile);
assertTrue(options.contains("/target/local-repo/umlgraph/UMLGraph/2.1/UMLGraph-2.1.jar"));
// ----------------------------------------------------------------------
// doclet-path: check if the file generated by UmlGraph exists and if
// doclet path contains the twice UmlGraph artifacts
// ----------------------------------------------------------------------
testPom = new File(unit, "doclet-path-test/doclet-path-test-plugin-config.xml");
mojo = lookupMojo(testPom);
setVariableValueToObject(mojo, "session", session);
mojo.execute();
generatedFile = new File(getBasedir(), "target/test/unit/doclet-test/target/site/apidocs/graph.dot");
assertTrue(FileUtils.fileExists(generatedFile.getAbsolutePath()));
optionsFile = new File(mojo.getOutputDirectory(), "options");
assertTrue(optionsFile.exists());
options = readFile(optionsFile);
assertTrue(options.contains("/target/local-repo/umlgraph/UMLGraph/2.1/UMLGraph-2.1.jar"));
assertTrue(options.contains("/target/local-repo/umlgraph/UMLGraph-bis/2.1/UMLGraph-bis-2.1.jar"));
}
use of org.apache.maven.execution.MavenSession in project maven-plugins by apache.
the class JavadocReportTest method testProxy.
/**
* Method to test proxy support in the javadoc
*
* @throws Exception if any
*/
public void testProxy() throws Exception {
Settings settings = new Settings();
Proxy proxy = new Proxy();
// dummy proxy
proxy.setActive(true);
proxy.setHost("127.0.0.1");
proxy.setPort(80);
proxy.setProtocol("http");
proxy.setUsername("toto");
proxy.setPassword("toto");
proxy.setNonProxyHosts("www.google.com|*.somewhere.com");
settings.addProxy(proxy);
File testPom = new File(getBasedir(), "src/test/resources/unit/proxy-test/proxy-test-plugin-config.xml");
JavadocReport mojo = lookupMojo(testPom);
MavenSession session = spy(newMavenSession(mojo.project));
ProjectBuildingRequest buildingRequest = mock(ProjectBuildingRequest.class);
when(buildingRequest.getRemoteRepositories()).thenReturn(mojo.project.getRemoteArtifactRepositories());
when(session.getProjectBuildingRequest()).thenReturn(buildingRequest);
MavenRepositorySystemSession repositorySession = new MavenRepositorySystemSession();
repositorySession.setLocalRepositoryManager(new SimpleLocalRepositoryManager(localRepo));
when(buildingRequest.getRepositorySession()).thenReturn(repositorySession);
when(session.getRepositorySession()).thenReturn(repositorySession);
LegacySupport legacySupport = lookup(LegacySupport.class);
legacySupport.setSession(session);
setVariableValueToObject(mojo, "settings", settings);
setVariableValueToObject(mojo, "session", session);
mojo.execute();
File commandLine = new File(getBasedir(), "target/test/unit/proxy-test/target/site/apidocs/javadoc." + (SystemUtils.IS_OS_WINDOWS ? "bat" : "sh"));
assertTrue(FileUtils.fileExists(commandLine.getAbsolutePath()));
String readed = readFile(commandLine);
assertTrue(readed.contains("-J-Dhttp.proxySet=true"));
assertTrue(readed.contains("-J-Dhttp.proxyHost=127.0.0.1"));
assertTrue(readed.contains("-J-Dhttp.proxyPort=80"));
assertTrue(readed.contains("-J-Dhttp.proxyUser=\\\"toto\\\""));
assertTrue(readed.contains("-J-Dhttp.proxyPassword=\\\"toto\\\""));
assertTrue(readed.contains("-J-Dhttp.nonProxyHosts=\\\"www.google.com|*.somewhere.com\\\""));
File options = new File(getBasedir(), "target/test/unit/proxy-test/target/site/apidocs/options");
assertTrue(FileUtils.fileExists(options.getAbsolutePath()));
String optionsContent = readFile(options);
// NO -link expected
assertFalse(optionsContent.contains("-link"));
// real proxy
ProxyServer proxyServer = null;
AuthAsyncProxyServlet proxyServlet;
try {
proxyServlet = new AuthAsyncProxyServlet();
proxyServer = new ProxyServer(proxyServlet);
proxyServer.start();
settings = new Settings();
proxy = new Proxy();
proxy.setActive(true);
proxy.setHost(proxyServer.getHostName());
proxy.setPort(proxyServer.getPort());
proxy.setProtocol("http");
settings.addProxy(proxy);
mojo = lookupMojo(testPom);
setVariableValueToObject(mojo, "settings", settings);
setVariableValueToObject(mojo, "session", session);
mojo.execute();
readed = readFile(commandLine);
assertTrue(readed.contains("-J-Dhttp.proxySet=true"));
assertTrue(readed.contains("-J-Dhttp.proxyHost=" + proxyServer.getHostName()));
assertTrue(readed.contains("-J-Dhttp.proxyPort=" + proxyServer.getPort()));
optionsContent = readFile(options);
// -link expected
// TODO: This got disabled for now!
// This test fails since the last commit but I actually think it only ever worked by accident.
// It did rely on a commons-logging-1.0.4.pom which got resolved by a test which did run previously.
// But after updating to commons-logging.1.1.1 there is no pre-resolved artifact available in
// target/local-repo anymore, thus the javadoc link info cannot get built and the test fails
// I'll for now just disable this line of code, because the test as far as I can see _never_
// did go upstream. The remoteRepository list used is always empty!.
//
// assertTrue( optionsContent.contains( "-link 'http://commons.apache.org/logging/apidocs'" ) );
} finally {
if (proxyServer != null) {
proxyServer.stop();
}
}
// auth proxy
Map<String, String> authentications = new HashMap<String, String>();
authentications.put("foo", "bar");
try {
proxyServlet = new AuthAsyncProxyServlet(authentications);
proxyServer = new ProxyServer(proxyServlet);
proxyServer.start();
settings = new Settings();
proxy = new Proxy();
proxy.setActive(true);
proxy.setHost(proxyServer.getHostName());
proxy.setPort(proxyServer.getPort());
proxy.setProtocol("http");
proxy.setUsername("foo");
proxy.setPassword("bar");
settings.addProxy(proxy);
mojo = lookupMojo(testPom);
setVariableValueToObject(mojo, "settings", settings);
setVariableValueToObject(mojo, "session", session);
mojo.execute();
readed = readFile(commandLine);
assertTrue(readed.contains("-J-Dhttp.proxySet=true"));
assertTrue(readed.contains("-J-Dhttp.proxyHost=" + proxyServer.getHostName()));
assertTrue(readed.contains("-J-Dhttp.proxyPort=" + proxyServer.getPort()));
assertTrue(readed.contains("-J-Dhttp.proxyUser=\\\"foo\\\""));
assertTrue(readed.contains("-J-Dhttp.proxyPassword=\\\"bar\\\""));
optionsContent = readFile(options);
// -link expected
// see comment above (line 829)
// assertTrue( optionsContent.contains( "-link 'http://commons.apache.org/logging/apidocs'" ) );
} finally {
if (proxyServer != null) {
proxyServer.stop();
}
}
}
use of org.apache.maven.execution.MavenSession in project maven-plugins by apache.
the class JavadocReportTest method testStylesheetfile.
/**
* Method to test the <code><stylesheetfile/></code> parameter.
*
* @throws Exception if any
*/
public void testStylesheetfile() throws Exception {
File testPom = new File(unit, "stylesheetfile-test/pom.xml");
JavadocReport mojo = lookupMojo(testPom);
assertNotNull(mojo);
MavenSession session = spy(newMavenSession(mojo.project));
ProjectBuildingRequest buildingRequest = mock(ProjectBuildingRequest.class);
when(buildingRequest.getRemoteRepositories()).thenReturn(mojo.project.getRemoteArtifactRepositories());
when(session.getProjectBuildingRequest()).thenReturn(buildingRequest);
MavenRepositorySystemSession repositorySession = new MavenRepositorySystemSession();
repositorySession.setLocalRepositoryManager(new SimpleLocalRepositoryManager(localRepo));
when(buildingRequest.getRepositorySession()).thenReturn(repositorySession);
when(session.getRepositorySession()).thenReturn(repositorySession);
LegacySupport legacySupport = lookup(LegacySupport.class);
legacySupport.setSession(session);
setVariableValueToObject(mojo, "session", session);
File apidocs = new File(getBasedir(), "target/test/unit/stylesheetfile-test/target/site/apidocs");
File stylesheetfile = new File(apidocs, "stylesheet.css");
File options = new File(apidocs, "options");
// stylesheet == maven OR java
setVariableValueToObject(mojo, "stylesheet", "javamaven");
try {
mojo.execute();
assertTrue(false);
} catch (Exception e) {
assertTrue(true);
}
// stylesheet == java
setVariableValueToObject(mojo, "stylesheet", "java");
mojo.execute();
String content = readFile(stylesheetfile);
assertTrue(content.contains("/* Javadoc style sheet */"));
String optionsContent = readFile(options);
assertFalse(optionsContent.contains("-stylesheetfile"));
// stylesheet == maven
setVariableValueToObject(mojo, "stylesheet", "maven");
mojo.execute();
content = readFile(stylesheetfile);
assertTrue(content.contains("/* Javadoc style sheet */") && content.contains("Licensed to the Apache Software Foundation (ASF) under one"));
optionsContent = readFile(options);
assertTrue(optionsContent.contains("-stylesheetfile"));
assertTrue(optionsContent.contains("'" + stylesheetfile.getAbsolutePath().replaceAll("\\\\", "/") + "'"));
// stylesheetfile defined as a project resource
setVariableValueToObject(mojo, "stylesheet", null);
setVariableValueToObject(mojo, "stylesheetfile", "com/mycompany/app/javadoc/css/stylesheet.css");
mojo.execute();
content = readFile(stylesheetfile);
assertTrue(content.contains("/* Custom Javadoc style sheet in project */"));
optionsContent = readFile(options);
assertTrue(optionsContent.contains("-stylesheetfile"));
File stylesheetResource = new File(unit, "stylesheetfile-test/src/main/resources/com/mycompany/app/javadoc/css/stylesheet.css");
assertTrue(optionsContent.contains("'" + stylesheetResource.getAbsolutePath().replaceAll("\\\\", "/") + "'"));
// stylesheetfile defined in a javadoc plugin dependency
setVariableValueToObject(mojo, "stylesheetfile", "com/mycompany/app/javadoc/css2/stylesheet.css");
mojo.execute();
content = readFile(stylesheetfile);
assertTrue(content.contains("/* Custom Javadoc style sheet in artefact */"));
optionsContent = readFile(options);
assertTrue(optionsContent.contains("-stylesheetfile"));
assertTrue(optionsContent.contains("'" + stylesheetfile.getAbsolutePath().replaceAll("\\\\", "/") + "'"));
// stylesheetfile defined as file
File css = new File(unit, "stylesheetfile-test/src/main/resources/com/mycompany/app/javadoc/css3/stylesheet.css");
setVariableValueToObject(mojo, "stylesheetfile", css.getAbsolutePath());
mojo.execute();
content = readFile(stylesheetfile);
assertTrue(content.contains("/* Custom Javadoc style sheet as file */"));
optionsContent = readFile(options);
assertTrue(optionsContent.contains("-stylesheetfile"));
stylesheetResource = new File(unit, "stylesheetfile-test/src/main/resources/com/mycompany/app/javadoc/css3/stylesheet.css");
assertTrue(optionsContent.contains("'" + stylesheetResource.getAbsolutePath().replaceAll("\\\\", "/") + "'"));
}
Aggregations