-
Notifications
You must be signed in to change notification settings - Fork 111
/
QuliceTask.java
196 lines (183 loc) · 6.16 KB
/
QuliceTask.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
186
187
188
189
190
191
192
193
194
195
196
/*
* Copyright (c) 2011-2023 Qulice.com
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met: 1) Redistributions of source code must retain the above
* copyright notice, this list of conditions and the following
* disclaimer. 2) Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the following
* disclaimer in the documentation and/or other materials provided
* with the distribution. 3) Neither the name of the Qulice.com nor
* the names of its contributors may be used to endorse or promote
* products derived from this software without specific prior written
* permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT
* NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
* FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
* THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
* INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
* OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package com.qulice.ant;
import com.jcabi.log.Logger;
import com.qulice.checkstyle.CheckstyleValidator;
import com.qulice.pmd.PmdValidator;
import com.qulice.spi.Environment;
import com.qulice.spi.ResourceValidator;
import com.qulice.spi.ValidationException;
import com.qulice.spi.Validator;
import com.qulice.spi.Violation;
import java.io.File;
import java.util.Arrays;
import java.util.Collection;
import java.util.LinkedList;
import org.apache.tools.ant.BuildException;
import org.apache.tools.ant.Task;
import org.apache.tools.ant.types.Path;
/**
* Ant Task for Qulice.
*
* @since 0.13
* @checkstyle ClassDataAbstractionCouplingCheck (170 lines)
*/
public final class QuliceTask extends Task {
/**
* Sources dirs.
*/
private Path sources;
/**
* Classes dir (only one dir is supported).
*/
private File classes;
/**
* Classpath dirs and files.
*/
private Path classpath;
/**
* Set source dirs.
* @param srcdr Source dirs
*/
public void setSrcdir(final Path srcdr) {
this.sources = srcdr;
}
/**
* Set classes dir.
* @param clssedr Classes dir
*/
public void setClassesdir(final File clssedr) {
this.classes = clssedr;
}
/**
* Set classpath.
* @param clsspth Classpath
*/
public void setClasspath(final Path clsspth) {
this.classpath = clsspth;
}
@Override
@SuppressWarnings({ "PMD.GuardLogStatement", "PMD.PrematureDeclaration"})
public void execute() {
super.execute();
final Environment env = this.environment();
final long start = System.nanoTime();
try {
QuliceTask.validate(env);
} catch (final ValidationException ex) {
Logger.info(
this,
"Read our quality policy: http://www.qulice.com/quality.html"
);
throw new BuildException("Failure", ex);
}
Logger.info(
this,
"Qulice quality check completed in %[nano]s, no errors",
System.nanoTime() - start
);
}
/**
* Create Environment.
* @return Environment.
*/
private Environment environment() {
if (this.sources == null) {
throw new BuildException("srcdir not defined for QuliceTask");
}
if (this.classes == null) {
throw new BuildException("classesdir not defined for QuliceTask");
}
if (this.classpath == null) {
throw new BuildException("classpath not defined for QuliceTask");
}
return new AntEnvironment(
new AntProject.Default(this.getProject()),
new AntPath.Default(this.sources),
this.classes,
new AntPath.Default(this.classpath)
);
}
/**
* Validate and throws exception if there are any problems.
* @param env Environment
* @throws ValidationException If there are any problems.
*/
private static void validate(final Environment env)
throws ValidationException {
final Collection<Violation> results = new LinkedList<>();
final Collection<File> files = env.files("*.*");
if (!files.isEmpty()) {
final Collection<ResourceValidator> validators =
QuliceTask.validators(env);
for (final ResourceValidator validator : validators) {
results.addAll(validator.validate(files));
}
for (final Violation result : results) {
Logger.info(
QuliceTask.class,
"%s: %s[%s]: %s (%s)",
result.validator(),
result.file(),
result.lines(),
result.message(),
result.name()
);
}
}
for (final Validator validator : QuliceTask.validators()) {
validator.validate(env);
}
if (!results.isEmpty()) {
throw new ValidationException(
String.format("%d violations, see log above", results.size())
);
}
}
/**
* Create collection of validators.
* @return Collection of validators.
*/
private static Collection<Validator> validators() {
return Arrays.asList();
}
/**
* Create collection of validators.
* @param env Environment to use.
* @return Collection of validators.
*/
private static Collection<ResourceValidator> validators(
final Environment env) {
return Arrays.asList(
new CheckstyleValidator(env),
new PmdValidator(env)
);
}
}