/
ValgrindMojo.java
185 lines (160 loc) · 5.04 KB
/
ValgrindMojo.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
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
package org.codehaus.mojo;
/*
* Copyright (C) 2011-2016, Neticoa SAS France - Tous droits réservés.
* Author(s) : Franck Bonin, Neticoa SAS France
*
* Licensed 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.HashMap;
import java.util.List;
import java.util.Map;
import org.apache.maven.plugins.annotations.LifecyclePhase;
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugins.annotations.Parameter;
/**
* Goal which valgrind executables.
*
* @author Franck Bonin
*/
@Mojo( name = "valgrind", defaultPhase = LifecyclePhase.TEST )
public class ValgrindMojo extends AbstractLaunchMojo
{
@Override
protected List<String> getArgsList()
{
return null;
}
/**
* The Report OutputFile Location.
*
* @since 0.0.4
*/
@Parameter( property = "valgrind.reportsfilePath", defaultValue = "valgrind-reports" )
private File reportsfileDir;
/**
* The Report OutputFile name identifier.
*
* @since 0.0.4
*/
@Parameter( property = "valgrind.reportIdentifier", defaultValue = "" )
private String reportIdentifier;
private String getReportFileName()
{
return "valgrind-result-" + reportIdentifier + ".xml";
}
/**
* Arguments for valgrind program. Shall be --leak-check=yes --demangle=yes --xml=yes
*
*/
@Parameter( property = "valgrind.args", defaultValue = "--leak-check=yes --demangle=yes --xml=yes" )
private String commandArgs;
@Override
protected String getCommandArgs()
{
String params = commandArgs + " ";
String outputReportName = new String();
if ( reportsfileDir.isAbsolute() )
{
outputReportName = reportsfileDir.getAbsolutePath() + "/" + getReportFileName();
}
else
{
outputReportName = basedir.getAbsolutePath() + "/" + reportsfileDir.getPath() + "/" + getReportFileName();
}
File file = new File( outputReportName );
new File( file.getParent() ).mkdirs();
params += "--xml-file=\"" + outputReportName + "\" ";
params += "\"" + instrumentedExecutablePath + "\" " + instrumentedExecutableArgs;
return params;
}
/**
* Path to executed (tested) program
*
*/
@Parameter( property = "valgrind.instrumented", required = true )
private String instrumentedExecutablePath;
/**
* Arguments of executed program
*
*/
@Parameter( property = "valgrind.instrumentedArgs", defaultValue = " " )
private String instrumentedExecutableArgs;
@Override
protected String getExecutable()
{
return "valgrind";
}
/**
* Environment variables passed to valgrind program.
*
* @since 0.0.4
*/
@Parameter()
private Map environmentVariables = new HashMap();
@Override
protected Map getMoreEnvironmentVariables()
{
return environmentVariables;
}
@Override
protected List<String> getSuccesCode()
{
return null;
}
/**
* The current working directory. Optional. If not specified, basedir will be used.
*
* @since 0.0.4
*/
@Parameter( property = "valgrind.workingdir" )
private File workingDir;
@Override
protected File getWorkingDir()
{
if ( null == workingDir )
{
workingDir = new File( basedir.getPath() );
}
return workingDir;
}
/**
* Set this to "true" to skip running tests, but still compile them. Its use is NOT RECOMMENDED, but quite
* convenient on occasion.
*
* @since 0.0.5
*/
@Parameter( property = "skipTests", defaultValue = "false" )
protected boolean skipTests;
/**
* Set this to "true" to bypass unit tests entirely. Its use is NOT RECOMMENDED, especially if you enable it
* using the "maven.test.skip" property, because maven.test.skip shall disables both running the tests and
* compiling the tests. Consider using the <code>skipTests</code> parameter instead.
*
* @since 0.0.5
*/
@Parameter( property = "maven.test.skip", defaultValue = "false" )
protected boolean skip;
@Override
protected boolean isSkip()
{
return localIsSkip() || skipTests || skip;
}
protected boolean localIsSkip()
{
String sOsName = System.getProperty( "os.name" );
// vilgrind will work on linux, macos, everything but windows
return sOsName.contains( "windows" );
}
}