-
Notifications
You must be signed in to change notification settings - Fork 2.6k
/
AbstractMavenPluginParametersValidator.java
153 lines (128 loc) · 4.57 KB
/
AbstractMavenPluginParametersValidator.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
package org.apache.maven.plugin.internal;
/*
* 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.util.Arrays;
import java.util.List;
import org.apache.maven.plugin.descriptor.Parameter;
import org.apache.maven.shared.utils.logging.MessageBuilder;
import org.apache.maven.shared.utils.logging.MessageUtils;
import org.codehaus.plexus.component.configurator.expression.ExpressionEvaluationException;
import org.codehaus.plexus.component.configurator.expression.ExpressionEvaluator;
import org.codehaus.plexus.configuration.PlexusConfiguration;
import org.slf4j.Logger;
/**
* Common implementations for plugin parameters configuration validation.
*
* @author Slawomir Jaranowski
*/
abstract class AbstractMavenPluginParametersValidator implements MavenPluginConfigurationValidator
{
// plugin author can provide @Parameter( property = "session" ) in this case property will always evaluate
// so, we need ignore those
// source org.apache.maven.plugin.PluginParameterExpressionEvaluator
private static final List<String> IGNORED_PROPERTY_VALUES = Arrays.asList(
"basedir",
"executedProject",
"localRepository",
"mojo",
"mojoExecution",
"plugin",
"project",
"reactorProjects",
"session",
"settings"
);
private static final List<String> IGNORED_PROPERTY_PREFIX = Arrays.asList(
"mojo.",
"pom.",
"plugin.",
"project.",
"session.",
"settings."
);
protected abstract Logger getLogger();
protected static boolean isValueSet( PlexusConfiguration config,
ExpressionEvaluator expressionEvaluator )
{
if ( config == null )
{
return false;
}
// there are sub items ... so configuration is declared
if ( config.getChildCount() > 0 )
{
return true;
}
String strValue = config.getValue();
if ( strValue == null || strValue.isEmpty() )
{
return false;
}
if ( isIgnoredProperty( strValue ) )
{
return false;
}
// for declaration like @Parameter( property = "config.property" )
// the value will contain ${config.property}
try
{
return expressionEvaluator.evaluate( strValue ) != null;
}
catch ( ExpressionEvaluationException e )
{
// not important
// will be reported during Mojo fields populate
}
// fallback - in case of error in expressionEvaluator
return false;
}
private static boolean isIgnoredProperty( String strValue )
{
if ( !strValue.startsWith( "${" ) )
{
return false;
}
String propertyName = strValue.replace( "${", "" ).replace( "}", "" );
if ( IGNORED_PROPERTY_VALUES.contains( propertyName ) )
{
return true;
}
return IGNORED_PROPERTY_PREFIX.stream().anyMatch( propertyName::startsWith );
}
protected abstract String getParameterLogReason( Parameter parameter );
protected void logParameter( Parameter parameter )
{
MessageBuilder messageBuilder = MessageUtils.buffer()
.warning( "Parameter '" )
.warning( parameter.getName() )
.warning( '\'' );
if ( parameter.getExpression() != null )
{
String userProperty = parameter.getExpression().replace( "${", "'" ).replace( '}', '\'' );
messageBuilder
.warning( " (user property " )
.warning( userProperty )
.warning( ")" );
}
messageBuilder
.warning( " " )
.warning( getParameterLogReason( parameter ) );
getLogger().warn( messageBuilder.toString() );
}
}