Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[MNG-7432] Resolver session contains non-MavenWorkspaceReader #695

Merged
merged 2 commits into from Apr 8, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
6 changes: 2 additions & 4 deletions maven-core/src/main/java/org/apache/maven/DefaultMaven.java
Expand Up @@ -40,6 +40,7 @@
import org.apache.maven.execution.ProjectDependencyGraph;
import org.apache.maven.graph.GraphBuilder;
import org.apache.maven.internal.aether.DefaultRepositorySystemSessionFactory;
import org.apache.maven.internal.aether.MavenChainedWorkspaceReader;
import org.apache.maven.lifecycle.internal.ExecutionEventCatapult;
import org.apache.maven.lifecycle.internal.LifecycleStarter;
import org.apache.maven.model.Prerequisites;
Expand All @@ -58,7 +59,6 @@
import org.eclipse.aether.DefaultRepositorySystemSession;
import org.eclipse.aether.RepositorySystemSession;
import org.eclipse.aether.repository.WorkspaceReader;
import org.eclipse.aether.util.repository.ChainedWorkspaceReader;

/**
* @author Jason van Zyl
Expand Down Expand Up @@ -338,9 +338,7 @@ private void setupWorkspaceReader( MavenSession session, DefaultRepositorySystem
}
workspaceReaders.add( workspaceReader );
}
WorkspaceReader[] readers = workspaceReaders.toArray( new WorkspaceReader[0] );
repoSession.setWorkspaceReader( new ChainedWorkspaceReader( readers ) );

repoSession.setWorkspaceReader( MavenChainedWorkspaceReader.of( workspaceReaders ) );
}

private void afterSessionEnd( Collection<MavenProject> projects, MavenSession session )
Expand Down
@@ -0,0 +1,106 @@
package org.apache.maven.internal.aether;

/*
* 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.
*/

import java.io.File;
import java.util.Collection;
import java.util.List;

import org.apache.maven.model.Model;
import org.apache.maven.repository.internal.MavenWorkspaceReader;
import org.eclipse.aether.artifact.Artifact;
import org.eclipse.aether.repository.WorkspaceReader;
import org.eclipse.aether.repository.WorkspaceRepository;
import org.eclipse.aether.util.repository.ChainedWorkspaceReader;

/**
* A maven workspace reader that delegates to a chain of other readers, effectively aggregating their contents.
*/
public final class MavenChainedWorkspaceReader
implements MavenWorkspaceReader
{

private ChainedWorkspaceReader delegate;

private WorkspaceReader[] readers;

/**
* Creates a new workspace reader by chaining the specified readers.
*
* @param readers The readers to chain must not be {@code null}.
*/
private MavenChainedWorkspaceReader( WorkspaceReader... readers )
{
this.delegate = new ChainedWorkspaceReader( readers );
this.readers = readers;
}

@Override
public Model findModel( Artifact artifact )
{
for ( WorkspaceReader workspaceReader : readers )
{
if ( workspaceReader instanceof MavenWorkspaceReader )
{
Model model = ( (MavenWorkspaceReader) workspaceReader ).findModel( artifact );
if ( model != null )
{
return model;
}
}
}
return null;
}

@Override
public WorkspaceRepository getRepository()
{
return delegate.getRepository();
}

@Override
public File findArtifact( Artifact artifact )
{
return delegate.findArtifact( artifact );
}

@Override
public List<String> findVersions( Artifact artifact )
{
return delegate.findVersions( artifact );
}

/**
* chains a collection of {@link WorkspaceReader}s
* @param workspaceReaderCollection the collection of readers, might be empty but never <code>null</code>
* @return if the collection contains only one item returns the single item, otherwise creates a new
* {@link MavenChainedWorkspaceReader} chaining all readers in the order of the given collection.
*/
public static WorkspaceReader of( Collection<WorkspaceReader> workspaceReaderCollection )
{
WorkspaceReader[] readers = workspaceReaderCollection.toArray( new WorkspaceReader[0] );
if ( readers.length == 1 )
Copy link
Member

@cstamas cstamas Apr 2, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd personally just remove this length check, and make it always wrapped (is simpler).

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the complexity is manageable given that in most cases there is only one WSP and we save useless loop calls in that case when it is used across the maven build.

Copy link
Member

@cstamas cstamas Apr 2, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Still, the check could happen then on collection, not after conversion to array, no? nvm, am fine with it as it is

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, I just used the "toArray" as we accept a collection and then getting the first element from collection requires to iterate over the collection, but if size is larger requires an toArray as well... in the end it dosn't make much a difference given that this only happens once per maven invocation.

{
return readers[0];
}
return new MavenChainedWorkspaceReader( readers );
}

}
29 changes: 29 additions & 0 deletions maven-core/src/test/java/org/apache/maven/DefaultMavenTest.java
Expand Up @@ -4,11 +4,15 @@
import org.apache.maven.artifact.DefaultArtifact;
import org.apache.maven.execution.MavenExecutionRequest;
import org.apache.maven.execution.MavenExecutionResult;
import org.apache.maven.execution.MavenSession;
import org.apache.maven.project.MavenProject;
import org.apache.maven.project.MavenProjectHelper;
import org.apache.maven.repository.internal.MavenWorkspaceReader;
import org.codehaus.plexus.component.annotations.Component;

import java.io.File;
import java.nio.file.Files;
import java.util.concurrent.atomic.AtomicReference;

import static java.util.Arrays.asList;

Expand All @@ -33,6 +37,31 @@
public class DefaultMavenTest
extends AbstractCoreMavenComponentTestCase
{
@Component( role = AbstractMavenLifecycleParticipant.class, hint = "WsrClassCatcher" )
private static final class WsrClassCatcher extends AbstractMavenLifecycleParticipant
{
private final AtomicReference<Class<?>> wsrClassRef = new AtomicReference<>( null );

@Override
public void afterProjectsRead( MavenSession session ) throws MavenExecutionException
{
wsrClassRef.set( session.getRepositorySession().getWorkspaceReader().getClass() );
}
}

public void testEnsureResolverSessionHasMavenWorkspaceReader() throws Exception
{
WsrClassCatcher wsrClassCatcher = ( WsrClassCatcher ) getContainer()
.lookup( AbstractMavenLifecycleParticipant.class, "WsrClassCatcher" );
Maven maven = getContainer().lookup( Maven.class );
MavenExecutionRequest request = createMavenExecutionRequest( getProject( "simple" ) ).setGoals( asList("validate") );

MavenExecutionResult result = maven.execute( request );

Class<?> wsrClass = wsrClassCatcher.wsrClassRef.get();
assertTrue( "is null", wsrClass != null );
assertTrue( String.valueOf( wsrClass ), MavenWorkspaceReader.class.isAssignableFrom( wsrClass ) );
}

public void testThatErrorDuringProjectDependencyGraphCreationAreStored()
throws Exception
Expand Down
10 changes: 10 additions & 0 deletions maven-core/src/test/projects/default-maven/simple/pom.xml
@@ -0,0 +1,10 @@
<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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>

<groupId>simple</groupId>
<artifactId>simple</artifactId>
<version>1.0-SNAPSHOT</version>
<packaging>pom</packaging>

</project>