Skip to content

Commit

Permalink
[MNG-6802] Fix bug in FileProfileActivator (#347)
Browse files Browse the repository at this point in the history
* [MNG-6802] FileProfileActivator changes exists

FileProfileActivator changes FileProfileActivator.exists
which lets flattened resolveCiFriendliesOnly depending
fail activating profile.

* [MNG-6802] Add java docs

* [MNG-6802] PR comments fixes

* Make ProfileActivationFilePathInterpolator a class
* call super.tearDown() last

* [MNG-6802] PR comments fixes

* Get rid of reusing local variables
* Rename file-> activationFile
* Move if ( missing ) to try block
* Update javadocs
* Replace string format with concatenation
* Replace FileReader to FileInputStream

* [MNG-6802] Update javadoc

* [MNG-6802] Switch to commons lang3 StringUtils

* [MNG-6802] Switch to commons lang3 StringUtils

* [MNG-6802] Switch to plexus-utils StringUtils back

* [MNG-6802] Switch to plexus-utils StringUtils back

* [MNG-6802] Resolve conflicts

* [MNG-6802] Upgrade tests

* [MNG-6802] Fix for windows

* [MNG-6802] Remove annotation

* [MNG-6802] Create a temp dir

* [MNG-6802] Remove space

* [MNG-6802] Small refactoring

* [MNG-6802] Use JUnit5 tempDir

* [MNG-6802] Use static import

* [MNG-6802] Remove plexus

* [MNG-6802] Remove plexus

* [MNG-6802] Fix checklstyle

* [MNG-6802] Restart build

* [MNG-6802] Restart build

* [MNG-6802] Restart build (last attempt)

* [MNG-6802] Fix PR comments

* [MNG-6802] Refactor try-catch

* [MNG-6802] Fix comments in FileProfileActivatorTest

* [MNG-6802] Use primitive

* [MNG-6802] Push down path
  • Loading branch information
dehasi committed May 15, 2021
1 parent fc806a2 commit 3fabb63
Show file tree
Hide file tree
Showing 6 changed files with 359 additions and 58 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@
import org.apache.maven.building.Source;
import org.apache.maven.feature.Features;
import org.apache.maven.model.Activation;
import org.apache.maven.model.ActivationFile;
import org.apache.maven.model.Build;
import org.apache.maven.model.Dependency;
import org.apache.maven.model.DependencyManagement;
Expand All @@ -74,11 +75,13 @@
import org.apache.maven.model.normalization.ModelNormalizer;
import org.apache.maven.model.path.ModelPathTranslator;
import org.apache.maven.model.path.ModelUrlNormalizer;
import org.apache.maven.model.path.ProfileActivationFilePathInterpolator;
import org.apache.maven.model.plugin.LifecycleBindingsInjector;
import org.apache.maven.model.plugin.PluginConfigurationExpander;
import org.apache.maven.model.plugin.ReportConfigurationExpander;
import org.apache.maven.model.plugin.ReportingConverter;
import org.apache.maven.model.profile.DefaultProfileActivationContext;
import org.apache.maven.model.profile.ProfileActivationContext;
import org.apache.maven.model.profile.ProfileInjector;
import org.apache.maven.model.profile.ProfileSelector;
import org.apache.maven.model.resolution.InvalidRepositoryException;
Expand All @@ -87,6 +90,7 @@
import org.apache.maven.model.resolution.WorkspaceModelResolver;
import org.apache.maven.model.superpom.SuperPomProvider;
import org.apache.maven.model.validation.ModelValidator;
import org.codehaus.plexus.interpolation.InterpolationException;
import org.codehaus.plexus.interpolation.MapBasedValueSource;
import org.codehaus.plexus.interpolation.StringSearchInterpolator;
import org.eclipse.sisu.Nullable;
Expand Down Expand Up @@ -153,6 +157,9 @@ public class DefaultModelBuilder

private ModelMerger modelMerger = new FileToRawModelMerger();

@Inject
private ProfileActivationFilePathInterpolator profileActivationFilePathInterpolator;

public DefaultModelBuilder setModelProcessor( ModelProcessor modelProcessor )
{
this.modelProcessor = modelProcessor;
Expand Down Expand Up @@ -255,12 +262,19 @@ public DefaultModelBuilder setReportingConverter( ReportingConverter reportingCo
return this;
}

public DefaultModelBuilder setProfileActivationFilePathInterpolator(
ProfileActivationFilePathInterpolator profileActivationFilePathInterpolator )
{
this.profileActivationFilePathInterpolator = profileActivationFilePathInterpolator;
return this;
}

@Override
public DefaultTransformerContextBuilder newTransformerContextBuilder()
{
return new DefaultTransformerContextBuilder();
}

@Override
public ModelBuildingResult build( ModelBuildingRequest request )
throws ModelBuildingException
Expand Down Expand Up @@ -401,7 +415,11 @@ private Model readEffectiveModel( final ModelBuildingRequest request, final Defa
// model normalization
modelNormalizer.mergeDuplicates( tmpModel, request, problems );

Map<String, Activation> interpolatedActivations = getProfileActivations( tmpModel, false );
profileActivationContext.setProjectProperties( tmpModel.getProperties() );

Map<String, Activation> interpolatedActivations = getInterpolatedActivations( rawModel,
profileActivationContext,
problems );
injectProfileActivations( tmpModel, interpolatedActivations );

// profile injection
Expand Down Expand Up @@ -482,6 +500,56 @@ else if ( !parentIds.add( parentData.getId() ) )
return resultModel;
}

private Map<String, Activation> getInterpolatedActivations( Model rawModel,
DefaultProfileActivationContext context,
DefaultModelProblemCollector problems )
{
Map<String, Activation> interpolatedActivations = getProfileActivations( rawModel, true );
for ( Activation activation : interpolatedActivations.values() )
{
if ( activation.getFile() != null )
{
replaceWithInterpolatedValue( activation.getFile(), context, problems );
}
}
return interpolatedActivations;
}

private void replaceWithInterpolatedValue( ActivationFile activationFile, ProfileActivationContext context,
DefaultModelProblemCollector problems )
{
try
{
if ( isNotEmpty( activationFile.getExists() ) )
{
String path = activationFile.getExists();
String absolutePath = profileActivationFilePathInterpolator.interpolate( path, context );
activationFile.setExists( absolutePath );
}
else if ( isNotEmpty( activationFile.getMissing() ) )
{
String path = activationFile.getMissing();
String absolutePath = profileActivationFilePathInterpolator.interpolate( path, context );
activationFile.setMissing( absolutePath );
}
}
catch ( InterpolationException e )
{
String path = isNotEmpty(
activationFile.getExists() ) ? activationFile.getExists() : activationFile.getMissing();

problems.add( new ModelProblemCollectorRequest( Severity.ERROR, Version.BASE ).setMessage(
"Failed to interpolate file location " + path + ": " + e.getMessage() ).setLocation(
activationFile.getLocation( isNotEmpty( activationFile.getExists() ) ? "exists" : "missing" ) )
.setException( e ) );
}
}

private static boolean isNotEmpty( String string )
{
return string != null && !string.isEmpty();
}

@Override
public ModelBuildingResult build( final ModelBuildingRequest request, final ModelBuildingResult result )
throws ModelBuildingException
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@
import org.apache.maven.model.path.ModelPathTranslator;
import org.apache.maven.model.path.ModelUrlNormalizer;
import org.apache.maven.model.path.PathTranslator;
import org.apache.maven.model.path.ProfileActivationFilePathInterpolator;
import org.apache.maven.model.path.UrlNormalizer;
import org.apache.maven.model.plugin.DefaultPluginConfigurationExpander;
import org.apache.maven.model.plugin.DefaultReportConfigurationExpander;
Expand Down Expand Up @@ -111,7 +112,13 @@ protected ProfileSelector newProfileSelector()
protected ProfileActivator[] newProfileActivators()
{
return new ProfileActivator[] { new JdkVersionProfileActivator(), new OperatingSystemProfileActivator(),
new PropertyProfileActivator(), new FileProfileActivator().setPathTranslator( newPathTranslator() ) };
new PropertyProfileActivator(), new FileProfileActivator()
.setProfileActivationFilePathInterpolator( newProfileActivationFilePathInterpolator() ) };
}

protected ProfileActivationFilePathInterpolator newProfileActivationFilePathInterpolator()
{
return new ProfileActivationFilePathInterpolator().setPathTranslator( newPathTranslator() );
}

protected UrlNormalizer newUrlNormalizer()
Expand Down Expand Up @@ -232,6 +239,7 @@ public DefaultModelBuilder newInstance()
modelBuilder.setPluginConfigurationExpander( newPluginConfigurationExpander() );
modelBuilder.setReportConfigurationExpander( newReportConfigurationExpander() );
modelBuilder.setReportingConverter( newReportingConverter() );
modelBuilder.setProfileActivationFilePathInterpolator( newProfileActivationFilePathInterpolator() );

return modelBuilder;
}
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,103 @@
package org.apache.maven.model.path;

/*
* 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 org.apache.maven.model.ActivationFile;
import org.apache.maven.model.profile.ProfileActivationContext;
import org.codehaus.plexus.interpolation.AbstractValueSource;
import org.codehaus.plexus.interpolation.InterpolationException;
import org.codehaus.plexus.interpolation.MapBasedValueSource;
import org.codehaus.plexus.interpolation.RegexBasedInterpolator;

import javax.inject.Inject;
import javax.inject.Named;
import javax.inject.Singleton;
import java.io.File;

/**
* Finds an absolute path for {@link ActivationFile#getExists()} or {@link ActivationFile#getMissing()}
*
* @author Ravil Galeyev
*/
@Named
@Singleton
public class ProfileActivationFilePathInterpolator
{

@Inject
private PathTranslator pathTranslator;

public ProfileActivationFilePathInterpolator setPathTranslator( PathTranslator pathTranslator )
{
this.pathTranslator = pathTranslator;
return this;
}

/**
* Interpolates given {@code path}.
*
* @return absolute path or {@code null} if the input was {@code null}
*/
public String interpolate( String path, ProfileActivationContext context ) throws InterpolationException
{
if ( path == null )
{
return null;
}

RegexBasedInterpolator interpolator = new RegexBasedInterpolator();

final File basedir = context.getProjectDirectory();

if ( basedir != null )
{
interpolator.addValueSource( new AbstractValueSource( false )
{
@Override
public Object getValue( String expression )
{
/*
* We intentionally only support ${basedir} and not ${project.basedir} as the latter form
* would suggest that other project.* expressions can be used which is beyond the design.
*/
if ( "basedir".equals( expression ) )
{
return basedir.getAbsolutePath();
}
return null;
}
} );
}
else if ( path.contains( "${basedir}" ) )
{
return null;
}

interpolator.addValueSource( new MapBasedValueSource( context.getProjectProperties() ) );

interpolator.addValueSource( new MapBasedValueSource( context.getUserProperties() ) );

interpolator.addValueSource( new MapBasedValueSource( context.getSystemProperties() ) );

String absolutePath = interpolator.interpolate( path, "" );

return pathTranslator.alignToBaseDirectory( absolutePath, basedir );
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -28,15 +28,13 @@
import org.apache.maven.model.Activation;
import org.apache.maven.model.ActivationFile;
import org.apache.maven.model.Profile;
import org.apache.maven.model.building.ModelProblemCollector;
import org.apache.maven.model.building.ModelProblem.Severity;
import org.apache.maven.model.building.ModelProblem.Version;
import org.apache.maven.model.building.ModelProblemCollector;
import org.apache.maven.model.building.ModelProblemCollectorRequest;
import org.apache.maven.model.path.PathTranslator;
import org.apache.maven.model.path.ProfileActivationFilePathInterpolator;
import org.apache.maven.model.profile.ProfileActivationContext;
import org.codehaus.plexus.interpolation.AbstractValueSource;
import org.codehaus.plexus.interpolation.MapBasedValueSource;
import org.codehaus.plexus.interpolation.RegexBasedInterpolator;
import org.codehaus.plexus.interpolation.InterpolationException;
import org.codehaus.plexus.util.StringUtils;

/**
Expand All @@ -58,11 +56,12 @@ public class FileProfileActivator
{

@Inject
private PathTranslator pathTranslator;
private ProfileActivationFilePathInterpolator profileActivationFilePathInterpolator;

public FileProfileActivator setPathTranslator( PathTranslator pathTranslator )
public FileProfileActivator setProfileActivationFilePathInterpolator(
ProfileActivationFilePathInterpolator profileActivationFilePathInterpolator )
{
this.pathTranslator = pathTranslator;
this.profileActivationFilePathInterpolator = profileActivationFilePathInterpolator;
return this;
}

Expand Down Expand Up @@ -101,64 +100,23 @@ else if ( StringUtils.isNotEmpty( file.getMissing() ) )
return false;
}

RegexBasedInterpolator interpolator = new RegexBasedInterpolator();

final File basedir = context.getProjectDirectory();

if ( basedir != null )
{
interpolator.addValueSource( new AbstractValueSource( false )
{
@Override
public Object getValue( String expression )
{
/*
* NOTE: We intentionally only support ${basedir} and not ${project.basedir} as the latter form
* would suggest that other project.* expressions can be used which is however beyond the design.
*/
if ( "basedir".equals( expression ) )
{
return basedir.getAbsolutePath();
}
return null;
}
} );
}
else if ( path.contains( "${basedir}" ) )
{
return false;
}

interpolator.addValueSource( new MapBasedValueSource( context.getProjectProperties() ) );

interpolator.addValueSource( new MapBasedValueSource( context.getUserProperties() ) );

interpolator.addValueSource( new MapBasedValueSource( context.getSystemProperties() ) );

try
{
path = interpolator.interpolate( path, "" );
path = profileActivationFilePathInterpolator.interpolate( path, context );
}
catch ( Exception e )
catch ( InterpolationException e )
{
problems.add( new ModelProblemCollectorRequest( Severity.ERROR, Version.BASE )
.setMessage( "Failed to interpolate file location " + path + " for profile " + profile.getId()
+ ": " + e.getMessage() )
+ ": " + e.getMessage() )
.setLocation( file.getLocation( missing ? "missing" : "exists" ) )
.setException( e ) );
return false;
}

path = pathTranslator.alignToBaseDirectory( path, basedir );

// replace activation value with interpolated value
if ( missing )
if ( path == null )
{
file.setMissing( path );
}
else
{
file.setExists( path );
return false;
}

File f = new File( path );
Expand Down
Loading

0 comments on commit 3fabb63

Please sign in to comment.