test/tools/javac/lib/ToolBox.java

Thu, 21 Feb 2013 15:26:46 +0000

author
mcimadamore
date
Thu, 21 Feb 2013 15:26:46 +0000
changeset 1599
9f0ec00514b6
parent 1591
dc8b7aa7cef3
child 1637
2e21ecd7a5ad
permissions
-rw-r--r--

8007461: Regression: bad overload resolution when inner class and outer class have method with same name
Summary: Fix regression in varargs method resolution introduced by bad refactoring
Reviewed-by: jjg

vromero@1591 1 /*
vromero@1591 2 * Copyright (c) 2013, Oracle and/or its affiliates. All rights reserved.
vromero@1591 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
vromero@1591 4 *
vromero@1591 5 * This code is free software; you can redistribute it and/or modify it
vromero@1591 6 * under the terms of the GNU General Public License version 2 only, as
vromero@1591 7 * published by the Free Software Foundation.
vromero@1591 8 *
vromero@1591 9 * This code is distributed in the hope that it will be useful, but WITHOUT
vromero@1591 10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
vromero@1591 11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
vromero@1591 12 * version 2 for more details (a copy is included in the LICENSE file that
vromero@1591 13 * accompanied this code).
vromero@1591 14 *
vromero@1591 15 * You should have received a copy of the GNU General Public License version
vromero@1591 16 * 2 along with this work; if not, write to the Free Software Foundation,
vromero@1591 17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
vromero@1591 18 *
vromero@1591 19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
vromero@1591 20 * or visit www.oracle.com if you need additional information or have any
vromero@1591 21 * questions.
vromero@1591 22 */
vromero@1591 23
vromero@1591 24 import java.io.BufferedReader;
vromero@1591 25 import java.io.File;
vromero@1591 26 import java.io.FileNotFoundException;
vromero@1591 27 import java.io.FileWriter;
vromero@1591 28 import java.io.IOException;
vromero@1591 29 import java.io.InputStreamReader;
vromero@1591 30 import java.io.PrintWriter;
vromero@1591 31 import java.io.StringWriter;
vromero@1591 32 import java.net.URI;
vromero@1591 33 import java.nio.charset.Charset;
vromero@1591 34 import java.nio.file.Files;
vromero@1591 35 import java.nio.file.Path;
vromero@1591 36 import java.nio.file.Paths;
vromero@1591 37 import java.nio.file.StandardOpenOption;
vromero@1591 38 import java.util.ArrayList;
vromero@1591 39 import java.util.Arrays;
vromero@1591 40 import java.util.Collection;
vromero@1591 41 import java.util.EnumSet;
vromero@1591 42 import java.util.List;
vromero@1591 43 import java.util.Map;
vromero@1591 44 import java.util.Set;
vromero@1591 45 import java.util.regex.Matcher;
vromero@1591 46 import java.util.regex.Pattern;
vromero@1591 47
vromero@1591 48 import javax.tools.JavaCompiler;
vromero@1591 49 import javax.tools.JavaFileObject;
vromero@1591 50 import javax.tools.SimpleJavaFileObject;
vromero@1591 51 import javax.tools.ToolProvider;
vromero@1591 52
vromero@1591 53 import com.sun.source.util.JavacTask;
vromero@1591 54 import com.sun.tools.javac.api.JavacTaskImpl;
vromero@1591 55
vromero@1591 56 import sun.tools.jar.Main;
vromero@1591 57
vromero@1591 58 import static java.nio.file.StandardCopyOption.*;
vromero@1591 59
vromero@1591 60 /**
vromero@1591 61 * Toolbox for jtreg tests.
vromero@1591 62 */
vromero@1591 63
vromero@1591 64 public class ToolBox {
vromero@1591 65
vromero@1591 66 public static final String lineSeparator = System.getProperty("line.separator");
vromero@1591 67 public static final String jdkUnderTest = System.getProperty("test.jdk");
vromero@1591 68 public static final String testVMOpts = System.getProperty("test.tool.vm.opts");
vromero@1591 69 public static final String javaBinary = Paths.get(jdkUnderTest, "bin", "java").toString();
vromero@1591 70 //why this one private. Because the function which provide also the test options should be used
vromero@1591 71 private static final String javacBinary = Paths.get(jdkUnderTest, "bin", "javac").toString();
vromero@1591 72
vromero@1591 73 private static final Charset defaultCharset = Charset.defaultCharset();
vromero@1591 74
vromero@1591 75 static final JavaCompiler comp = ToolProvider.getSystemJavaCompiler();
vromero@1591 76
vromero@1591 77 /**
vromero@1591 78 * The expected result of command-like method execution.
vromero@1591 79 */
vromero@1591 80 public enum Expect {SUCCESS, FAIL}
vromero@1591 81
vromero@1591 82 enum AcceptedParams {
vromero@1591 83 EXPECT,
vromero@1591 84 SOURCES,
vromero@1591 85 OPTIONS,
vromero@1591 86 STD_OUTPUT,
vromero@1591 87 ERR_OUTPUT,
vromero@1591 88 EXTRA_ENV,
vromero@1591 89 }
vromero@1591 90
vromero@1591 91 enum OutputKind {STD, ERR}
vromero@1591 92
vromero@1591 93 /**
vromero@1591 94 * Helper class to abstract the processing of command's output.
vromero@1591 95 */
vromero@1591 96 static abstract class WriterHelper {
vromero@1591 97 OutputKind kind;
vromero@1591 98 public abstract void pipeOutput(ProcessBuilder pb);
vromero@1591 99 public abstract void readFromStream(Process p) throws IOException;
vromero@1591 100 public abstract void addAll(Collection<? extends String> c) throws IOException;
vromero@1591 101 }
vromero@1591 102
vromero@1591 103 /**
vromero@1591 104 * Helper class for redirecting command's output to a file.
vromero@1591 105 */
vromero@1591 106 static class FileWriterHelper extends WriterHelper {
vromero@1591 107 File file;
vromero@1591 108
vromero@1591 109 FileWriterHelper(File file, OutputKind kind) {
vromero@1591 110 this.file = file;
vromero@1591 111 this.kind = kind;
vromero@1591 112 }
vromero@1591 113
vromero@1591 114 @Override
vromero@1591 115 public void pipeOutput(ProcessBuilder pb) {
vromero@1591 116 if (file != null) {
vromero@1591 117 switch (kind) {
vromero@1591 118 case STD:
vromero@1591 119 pb.redirectInput(file);
vromero@1591 120 break;
vromero@1591 121 case ERR:
vromero@1591 122 pb.redirectError(file);
vromero@1591 123 break;
vromero@1591 124 }
vromero@1591 125 }
vromero@1591 126 }
vromero@1591 127
vromero@1591 128 @Override
vromero@1591 129 public void readFromStream(Process p) throws IOException {}
vromero@1591 130
vromero@1591 131 @Override
vromero@1591 132 public void addAll(Collection<? extends String> c) throws IOException {
vromero@1591 133 if (file.exists())
vromero@1591 134 Files.write(file.toPath(), c, defaultCharset,
vromero@1591 135 StandardOpenOption.WRITE, StandardOpenOption.APPEND);
vromero@1591 136 else
vromero@1591 137 Files.write(file.toPath(), c, defaultCharset);
vromero@1591 138 }
vromero@1591 139 }
vromero@1591 140
vromero@1591 141 /**
vromero@1591 142 * Helper class for redirecting command's output to a String list.
vromero@1591 143 */
vromero@1591 144 static class ListWriterHelper extends WriterHelper {
vromero@1591 145 List<String> list;
vromero@1591 146
vromero@1591 147 public ListWriterHelper(List<String> list, OutputKind kind) {
vromero@1591 148 this.kind = kind;
vromero@1591 149 this.list = list;
vromero@1591 150 }
vromero@1591 151
vromero@1591 152 @Override
vromero@1591 153 public void pipeOutput(ProcessBuilder pb) {}
vromero@1591 154
vromero@1591 155 @Override
vromero@1591 156 public void readFromStream(Process p) throws IOException {
vromero@1591 157 BufferedReader br = null;
vromero@1591 158 switch (kind) {
vromero@1591 159 case STD:
vromero@1591 160 br = new BufferedReader(new InputStreamReader(p.getInputStream()));
vromero@1591 161 break;
vromero@1591 162 case ERR:
vromero@1591 163 br = new BufferedReader(new InputStreamReader(p.getErrorStream()));
vromero@1591 164 break;
vromero@1591 165 }
vromero@1591 166 String line;
vromero@1591 167 while ((line = br.readLine()) != null) {
vromero@1591 168 list.add(line);
vromero@1591 169 }
vromero@1591 170 }
vromero@1591 171
vromero@1591 172 public void addAll(Collection<? extends String> c) {
vromero@1591 173 list.addAll(c);
vromero@1591 174 }
vromero@1591 175 }
vromero@1591 176
vromero@1591 177 /**
vromero@1591 178 * Simple factory class for creating a WriterHelper instance.
vromero@1591 179 */
vromero@1591 180 static class WriterHelperFactory {
vromero@1591 181 static WriterHelper make(File file, OutputKind kind) {
vromero@1591 182 return new FileWriterHelper(file, kind);
vromero@1591 183 }
vromero@1591 184
vromero@1591 185 static WriterHelper make(List<String> list, OutputKind kind) {
vromero@1591 186 return new ListWriterHelper(list, kind);
vromero@1591 187 }
vromero@1591 188 }
vromero@1591 189
vromero@1591 190 /**
vromero@1591 191 * A generic class for holding command's arguments.
vromero@1591 192 */
vromero@1591 193 public static abstract class GenericArgs <T extends GenericArgs> {
vromero@1591 194 protected static List<Set<AcceptedParams>> minAcceptedParams;
vromero@1591 195
vromero@1591 196 protected Set<AcceptedParams> currentParams =
vromero@1591 197 EnumSet.<AcceptedParams>noneOf(AcceptedParams.class);
vromero@1591 198
vromero@1591 199 protected Expect whatToExpect;
vromero@1591 200 protected WriterHelper stdOutput;
vromero@1591 201 protected WriterHelper errOutput;
vromero@1591 202 protected List<String> options;
vromero@1591 203 protected String[] optionsArr;
vromero@1591 204
vromero@1591 205 protected GenericArgs() {
vromero@1591 206 set(Expect.SUCCESS);
vromero@1591 207 }
vromero@1591 208
vromero@1591 209 public T set(Expect whatToExpt) {
vromero@1591 210 currentParams.add(AcceptedParams.EXPECT);
vromero@1591 211 this.whatToExpect = whatToExpt;
vromero@1591 212 return (T)this;
vromero@1591 213 }
vromero@1591 214
vromero@1591 215 public T setStdOutput(List<String> stdOutput) {
vromero@1591 216 currentParams.add(AcceptedParams.STD_OUTPUT);
vromero@1591 217 this.stdOutput = WriterHelperFactory.make(stdOutput, OutputKind.STD);
vromero@1591 218 return (T)this;
vromero@1591 219 }
vromero@1591 220
vromero@1591 221 public T setStdOutput(File output) {
vromero@1591 222 currentParams.add(AcceptedParams.STD_OUTPUT);
vromero@1591 223 this.stdOutput = WriterHelperFactory.make(output, OutputKind.STD);
vromero@1591 224 return (T)this;
vromero@1591 225 }
vromero@1591 226
vromero@1591 227 public T setErrOutput(List<String> errOutput) {
vromero@1591 228 currentParams.add(AcceptedParams.ERR_OUTPUT);
vromero@1591 229 this.errOutput = WriterHelperFactory.make(errOutput, OutputKind.ERR);
vromero@1591 230 return (T)this;
vromero@1591 231 }
vromero@1591 232
vromero@1591 233 public T setErrOutput(File errOutput) {
vromero@1591 234 currentParams.add(AcceptedParams.ERR_OUTPUT);
vromero@1591 235 this.errOutput = WriterHelperFactory.make(errOutput, OutputKind.ERR);
vromero@1591 236 return (T)this;
vromero@1591 237 }
vromero@1591 238
vromero@1591 239 public T setAllArgs(String... args) {
vromero@1591 240 currentParams.add(AcceptedParams.OPTIONS);
vromero@1591 241 this.optionsArr = args;
vromero@1591 242 return (T)this;
vromero@1591 243 }
vromero@1591 244
vromero@1591 245 public T setOptions(List<String> options) {
vromero@1591 246 currentParams.add(AcceptedParams.OPTIONS);
vromero@1591 247 this.options = options;
vromero@1591 248 return (T)this;
vromero@1591 249 }
vromero@1591 250
vromero@1591 251 public T setOptions(String... options) {
vromero@1591 252 currentParams.add(AcceptedParams.OPTIONS);
vromero@1591 253 this.options = Arrays.asList(options);
vromero@1591 254 return (T)this;
vromero@1591 255 }
vromero@1591 256
vromero@1591 257 public boolean hasMinParams() {
vromero@1591 258 for (Set<AcceptedParams> minSet : minAcceptedParams) {
vromero@1591 259 if (currentParams.containsAll(minSet)) {
vromero@1591 260 return true;
vromero@1591 261 }
vromero@1591 262 }
vromero@1591 263 return false;
vromero@1591 264 }
vromero@1591 265 }
vromero@1591 266
vromero@1591 267 /**
vromero@1591 268 * A more specific class for holding javac-like command's arguments.
vromero@1591 269 */
vromero@1591 270 public static class JavaToolArgs extends GenericArgs<JavaToolArgs> {
vromero@1591 271
vromero@1591 272 static {
vromero@1591 273 minAcceptedParams = new ArrayList<>();
vromero@1591 274 minAcceptedParams.add(EnumSet.<AcceptedParams>of(
vromero@1591 275 AcceptedParams.EXPECT, AcceptedParams.OPTIONS));
vromero@1591 276 minAcceptedParams.add(EnumSet.<AcceptedParams>of(
vromero@1591 277 AcceptedParams.EXPECT, AcceptedParams.SOURCES));
vromero@1591 278 }
vromero@1591 279
vromero@1591 280 protected List<? extends JavaFileObject> sources;
vromero@1591 281
vromero@1591 282 public JavaToolArgs() {
vromero@1591 283 super();
vromero@1591 284 }
vromero@1591 285
vromero@1591 286 public JavaToolArgs(Expect whatToExpt) {
vromero@1591 287 super.set(whatToExpt);
vromero@1591 288 }
vromero@1591 289
vromero@1591 290 public JavaToolArgs setSources(List<? extends JavaFileObject> sources) {
vromero@1591 291 currentParams.add(AcceptedParams.SOURCES);
vromero@1591 292 this.sources = sources;
vromero@1591 293 return this;
vromero@1591 294 }
vromero@1591 295
vromero@1591 296 public JavaToolArgs setSources(JavaSource... sources) {
vromero@1591 297 return setSources(Arrays.asList(sources));
vromero@1591 298 }
vromero@1591 299
vromero@1591 300 public JavaToolArgs setSources(String... sources) {
vromero@1591 301 List<JavaSource> javaSrcs = new ArrayList<>();
vromero@1591 302 for (String source : sources) {
vromero@1591 303 javaSrcs.add(new JavaSource(source));
vromero@1591 304 }
vromero@1591 305 return setSources(javaSrcs);
vromero@1591 306 }
vromero@1591 307 }
vromero@1591 308
vromero@1591 309 /**
vromero@1591 310 * A more specific class for holding any command's arguments.
vromero@1591 311 */
vromero@1591 312 public static class AnyToolArgs extends GenericArgs<AnyToolArgs> {
vromero@1591 313
vromero@1591 314 static {
vromero@1591 315 minAcceptedParams = new ArrayList<>();
vromero@1591 316 minAcceptedParams.add(EnumSet.<AcceptedParams>of(
vromero@1591 317 AcceptedParams.EXPECT, AcceptedParams.OPTIONS));
vromero@1591 318 }
vromero@1591 319
vromero@1591 320 Map<String, String> extraEnv;
vromero@1591 321
vromero@1591 322 public AnyToolArgs() {
vromero@1591 323 super();
vromero@1591 324 }
vromero@1591 325
vromero@1591 326 public AnyToolArgs(Expect whatToExpt) {
vromero@1591 327 set(whatToExpt);
vromero@1591 328 }
vromero@1591 329
vromero@1591 330 public AnyToolArgs set(Map<String, String> extraEnv) {
vromero@1591 331 currentParams.add(AcceptedParams.EXTRA_ENV);
vromero@1591 332 this.extraEnv = extraEnv;
vromero@1591 333 return this;
vromero@1591 334 }
vromero@1591 335 }
vromero@1591 336
vromero@1591 337 /**
vromero@1591 338 * Custom exception for bad command execution.
vromero@1591 339 */
vromero@1591 340 public static class CommandExecutionException extends Exception {
vromero@1591 341 CommandExecutionException(List<String> command, Expect whatToExpt) {
vromero@1591 342 super(createMessage(command, whatToExpt));
vromero@1591 343 }
vromero@1591 344
vromero@1591 345 CommandExecutionException(Expect whatToExpt, String... command) {
vromero@1591 346 this(Arrays.asList(command), whatToExpt);
vromero@1591 347 }
vromero@1591 348
vromero@1591 349 private static String createMessage(List<String> command, Expect whatToExpt) {
vromero@1591 350 StringBuilder sb = new StringBuilder().append("Command : ");
vromero@1591 351 sb.append(command.toString()).append(lineSeparator);
vromero@1591 352 switch (whatToExpt) {
vromero@1591 353 case SUCCESS:
vromero@1591 354 sb.append(" has unexpectedly failed");
vromero@1591 355 break;
vromero@1591 356 case FAIL:
vromero@1591 357 sb.append(" has been unexpectedly successful");
vromero@1591 358 break;
vromero@1591 359 }
vromero@1591 360 return sb.toString();
vromero@1591 361 }
vromero@1591 362 }
vromero@1591 363
vromero@1591 364 /**
vromero@1591 365 * Custom exception for not equal resources.
vromero@1591 366 */
vromero@1591 367 public static class ResourcesNotEqualException extends Exception {
vromero@1591 368 public ResourcesNotEqualException() {
vromero@1591 369 super("The resources provided for comparison are different");
vromero@1591 370 }
vromero@1591 371
vromero@1591 372 public ResourcesNotEqualException(Path path1, Path path2) {
vromero@1591 373 super(createMessage(path1, path2));
vromero@1591 374 }
vromero@1591 375
vromero@1591 376 private static String createMessage(Path path1, Path path2) {
vromero@1591 377 return new StringBuilder()
vromero@1591 378 .append("The resources provided for comparison in paths \n")
vromero@1591 379 .append(path1.toString()).append(" and \n")
vromero@1591 380 .append(path2.toString()).append("are different").toString();
vromero@1591 381 }
vromero@1591 382 }
vromero@1591 383
vromero@1591 384 /**
vromero@1591 385 * Method to get the a path to the javac command available at the jdk being
vromero@1591 386 * tested along with the test vm options.
vromero@1591 387 * @return a String[] with the two components mentioned.
vromero@1591 388 */
vromero@1591 389 public static String[] getJavacBin() {
vromero@1591 390 return new String[]{javacBinary, testVMOpts};
vromero@1591 391 }
vromero@1591 392
vromero@1591 393 /**
vromero@1591 394 * A javac compiler caller method.
vromero@1591 395 */
vromero@1591 396 public static int javac(JavaToolArgs params)
vromero@1591 397 throws CommandExecutionException, IOException {
vromero@1591 398 if (params.hasMinParams()) {
vromero@1591 399 if (params.optionsArr != null) {
vromero@1591 400 return genericJavaCMD(JavaCMD.JAVAC, params);
vromero@1591 401 } else {
vromero@1591 402 return genericJavaCMD(JavaCMD.JAVAC_API, params);
vromero@1591 403 }
vromero@1591 404 }
vromero@1591 405 throw new AssertionError("javac command has been invoked with less parameters than needed");
vromero@1591 406 }
vromero@1591 407
vromero@1591 408 /**
vromero@1591 409 * A javap calling method.
vromero@1591 410 */
vromero@1591 411 public static String javap(JavaToolArgs params)
vromero@1591 412 throws CommandExecutionException, IOException {
vromero@1591 413 if (params.hasMinParams()) {
vromero@1591 414 List<String> list = new ArrayList<>();
vromero@1591 415 params.setErrOutput(list);
vromero@1591 416 genericJavaCMD(JavaCMD.JAVAP, params);
vromero@1591 417 return listToString(list);
vromero@1591 418 }
vromero@1591 419 throw new AssertionError("javap command has been invoked with less parameters than needed");
vromero@1591 420 }
vromero@1591 421
vromero@1591 422 /**
vromero@1591 423 * A javah calling method.
vromero@1591 424 */
vromero@1591 425 public static int javah(JavaToolArgs params)
vromero@1591 426 throws CommandExecutionException, IOException {
vromero@1591 427 if (params.hasMinParams()) {
vromero@1591 428 return genericJavaCMD(JavaCMD.JAVAH, params);
vromero@1591 429 }
vromero@1591 430 throw new AssertionError("javah command has been invoked with less parameters than needed");
vromero@1591 431 }
vromero@1591 432
vromero@1591 433 /**
vromero@1591 434 * A enum class for langtools commands.
vromero@1591 435 */
vromero@1591 436 enum JavaCMD {
vromero@1591 437 JAVAC {
vromero@1591 438 @Override
vromero@1591 439 int run(JavaToolArgs params, PrintWriter pw) {
vromero@1591 440 return com.sun.tools.javac.Main.compile(params.optionsArr, pw);
vromero@1591 441 }
vromero@1591 442 },
vromero@1591 443 JAVAC_API {
vromero@1591 444 @Override
vromero@1591 445 int run(JavaToolArgs params, PrintWriter pw) {
vromero@1591 446 JavacTask ct = (JavacTask)comp.getTask(pw, null, null,
vromero@1591 447 params.options, null, params.sources);
vromero@1591 448 return ((JavacTaskImpl)ct).doCall().exitCode;
vromero@1591 449 }
vromero@1591 450
vromero@1591 451 @Override
vromero@1591 452 String getName() {
vromero@1591 453 return "javac";
vromero@1591 454 }
vromero@1591 455
vromero@1591 456 @Override
vromero@1591 457 List<String> getExceptionMsgContent(JavaToolArgs params) {
vromero@1591 458 List<String> result = super.getExceptionMsgContent(params);
vromero@1591 459 for (JavaFileObject source : params.sources) {
vromero@1591 460 if (source instanceof JavaSource) {
vromero@1591 461 result.add(((JavaSource)source).name);
vromero@1591 462 }
vromero@1591 463 }
vromero@1591 464 return result;
vromero@1591 465 }
vromero@1591 466 },
vromero@1591 467 JAVAH {
vromero@1591 468 @Override
vromero@1591 469 int run(JavaToolArgs params, PrintWriter pw) {
vromero@1591 470 return com.sun.tools.javah.Main.run(params.optionsArr, pw);
vromero@1591 471 }
vromero@1591 472 },
vromero@1591 473 JAVAP {
vromero@1591 474 @Override
vromero@1591 475 int run(JavaToolArgs params, PrintWriter pw) {
vromero@1591 476 return com.sun.tools.javap.Main.run(params.optionsArr, pw);
vromero@1591 477 }
vromero@1591 478 };
vromero@1591 479
vromero@1591 480 abstract int run(JavaToolArgs params, PrintWriter pw);
vromero@1591 481
vromero@1591 482 String getName() {
vromero@1591 483 return this.name().toLowerCase();
vromero@1591 484 }
vromero@1591 485
vromero@1591 486 List<String> getExceptionMsgContent(JavaToolArgs params) {
vromero@1591 487 List<String> result = new ArrayList<>();
vromero@1591 488 result.add(getName());
vromero@1591 489 result.addAll(params.optionsArr != null ?
vromero@1591 490 Arrays.asList(params.optionsArr) :
vromero@1591 491 params.options);
vromero@1591 492 return result;
vromero@1591 493 }
vromero@1591 494 }
vromero@1591 495
vromero@1591 496 /**
vromero@1591 497 * A helper method for executing langtools commands.
vromero@1591 498 */
vromero@1591 499 private static int genericJavaCMD(
vromero@1591 500 JavaCMD cmd,
vromero@1591 501 JavaToolArgs params)
vromero@1591 502 throws CommandExecutionException, IOException {
vromero@1591 503 int rc = 0;
vromero@1591 504 StringWriter sw = null;
vromero@1591 505 try (PrintWriter pw = (params.errOutput == null) ?
vromero@1591 506 null : new PrintWriter(sw = new StringWriter())) {
vromero@1591 507 rc = cmd.run(params, pw);
vromero@1591 508 }
vromero@1591 509 String out = (sw == null) ? null : sw.toString();
vromero@1591 510
vromero@1591 511 if (params.errOutput != null && (out != null) && !out.isEmpty()) {
vromero@1591 512 params.errOutput.addAll(splitLines(out));
vromero@1591 513 }
vromero@1591 514
vromero@1591 515 if ( (rc == 0 && params.whatToExpect == Expect.SUCCESS) ||
vromero@1591 516 (rc != 0 && params.whatToExpect == Expect.FAIL) ) {
vromero@1591 517 return rc;
vromero@1591 518 }
vromero@1591 519
vromero@1591 520 throw new CommandExecutionException(cmd.getExceptionMsgContent(params),
vromero@1591 521 params.whatToExpect);
vromero@1591 522 }
vromero@1591 523
vromero@1591 524 /**
vromero@1591 525 * A jar calling method.
vromero@1591 526 */
vromero@1591 527 public static boolean jar(String... params) throws CommandExecutionException {
vromero@1591 528 Main jarGenerator = new Main(System.out, System.err, "jar");
vromero@1591 529 boolean result = jarGenerator.run(params);
vromero@1591 530 if (!result) {
vromero@1591 531 List<String> command = new ArrayList<>();
vromero@1591 532 command.add("jar");
vromero@1591 533 command.addAll(Arrays.asList(params));
vromero@1591 534 throw new CommandExecutionException(command, Expect.SUCCESS);
vromero@1591 535 }
vromero@1591 536 return result;
vromero@1591 537 }
vromero@1591 538
vromero@1591 539 /**
vromero@1591 540 * A general command calling method.
vromero@1591 541 */
vromero@1591 542 public static int executeCommand(AnyToolArgs params)
vromero@1591 543 throws CommandExecutionException, IOException, InterruptedException {
vromero@1591 544 if (params.hasMinParams()) {
vromero@1591 545 List<String> cmd = (params.options != null) ?
vromero@1591 546 params.options :
vromero@1591 547 Arrays.asList(params.optionsArr);
vromero@1591 548 return executeCommand(cmd, params.extraEnv, params.stdOutput,
vromero@1591 549 params.errOutput, params.whatToExpect);
vromero@1591 550 }
vromero@1591 551 throw new AssertionError("command has been invoked with less parameters than needed");
vromero@1591 552 }
vromero@1591 553
vromero@1591 554 /**
vromero@1591 555 * A helper method for calling a general command.
vromero@1591 556 */
vromero@1591 557 private static int executeCommand(
vromero@1591 558 List<String> command,
vromero@1591 559 Map<String, String> extraEnv,
vromero@1591 560 WriterHelper stdOutput,
vromero@1591 561 WriterHelper errOutput,
vromero@1591 562 Expect whatToExpt)
vromero@1591 563 throws IOException, InterruptedException, CommandExecutionException {
vromero@1591 564 ProcessBuilder pb = new ProcessBuilder(command);
vromero@1591 565
vromero@1591 566 if (stdOutput != null) stdOutput.pipeOutput(pb);
vromero@1591 567 if (errOutput != null) errOutput.pipeOutput(pb);
vromero@1591 568
vromero@1591 569 if (extraEnv != null) {
vromero@1591 570 pb.environment().putAll(extraEnv);
vromero@1591 571 }
vromero@1591 572
vromero@1591 573 Process p = pb.start();
vromero@1591 574
vromero@1591 575 if (stdOutput != null) stdOutput.readFromStream(p);
vromero@1591 576 if (errOutput != null) errOutput.readFromStream(p);
vromero@1591 577
vromero@1591 578 int result = p.waitFor();
vromero@1591 579 if ( (result == 0 && whatToExpt == Expect.SUCCESS) ||
vromero@1591 580 (result != 0 && whatToExpt == Expect.FAIL) ) {
vromero@1591 581 return result;
vromero@1591 582 }
vromero@1591 583
vromero@1591 584 throw new CommandExecutionException(command, whatToExpt);
vromero@1591 585 }
vromero@1591 586
vromero@1591 587 /**
vromero@1591 588 * This set of methods can be used instead of diff when the only needed
vromero@1591 589 * result is the equality or inequality of the two given resources.
vromero@1591 590 *
vromero@1591 591 * A resource can be a file or a String list.
vromero@1591 592 */
vromero@1591 593 public static void compareLines(Path aPath, Path otherPath, String encoding)
vromero@1591 594 throws FileNotFoundException, IOException, ResourcesNotEqualException {
vromero@1591 595 compareLines(aPath, otherPath, encoding, false);
vromero@1591 596 }
vromero@1591 597
vromero@1591 598 public static void compareLines(
vromero@1591 599 Path aPath, Path otherPath, String encoding, boolean trim)
vromero@1591 600 throws FileNotFoundException, IOException, ResourcesNotEqualException {
vromero@1591 601 Charset charset = encoding != null ?
vromero@1591 602 Charset.forName(encoding) :
vromero@1591 603 defaultCharset;
vromero@1591 604 List<String> list1 = Files.readAllLines(aPath, charset);
vromero@1591 605 List<String> list2 = Files.readAllLines(otherPath, charset);
vromero@1591 606 compareLines(list1, list2, trim);
vromero@1591 607 }
vromero@1591 608
vromero@1591 609 public static void compareLines(Path path, List<String> strings, String encoding)
vromero@1591 610 throws FileNotFoundException, IOException, ResourcesNotEqualException {
vromero@1591 611 compareLines(path, strings, encoding, false);
vromero@1591 612 }
vromero@1591 613
vromero@1591 614 public static void compareLines(Path path, List<String> strings,
vromero@1591 615 String encoding, boolean trim)
vromero@1591 616 throws FileNotFoundException, IOException, ResourcesNotEqualException {
vromero@1591 617 Charset charset = encoding != null ?
vromero@1591 618 Charset.forName(encoding) :
vromero@1591 619 defaultCharset;
vromero@1591 620 List<String> list = Files.readAllLines(path, charset);
vromero@1591 621 compareLines(list, strings, trim);
vromero@1591 622 }
vromero@1591 623
vromero@1591 624 public static void compareLines(List<String> list1, List<String> list2)
vromero@1591 625 throws ResourcesNotEqualException {
vromero@1591 626 compareLines(list1, list2, false);
vromero@1591 627 }
vromero@1591 628
vromero@1591 629 public static void compareLines(List<String> list1,
vromero@1591 630 List<String> list2, boolean trim) throws ResourcesNotEqualException {
vromero@1591 631 if ((list1 == list2) || (list1 == null && list2 == null)) return;
vromero@1591 632 if (list1.size() != list2.size())
vromero@1591 633 throw new ResourcesNotEqualException();
vromero@1591 634 int i = 0;
vromero@1591 635 int j = 0;
vromero@1591 636 while (i < list1.size() &&
vromero@1591 637 j < list2.size() &&
vromero@1591 638 equals(list1.get(i), list2.get(j), trim)) {
vromero@1591 639 i++; j++;
vromero@1591 640 }
vromero@1591 641 if (!(i == list1.size() && j == list2.size()))
vromero@1591 642 throw new ResourcesNotEqualException();
vromero@1591 643 }
vromero@1591 644
vromero@1591 645 private static boolean equals(String s1, String s2, boolean trim) {
vromero@1591 646 return (trim ? s1.trim().equals(s2.trim()) : s1.equals(s2));
vromero@1591 647 }
vromero@1591 648
vromero@1591 649 /**
vromero@1591 650 * A set of simple grep-like methods, looks for regExpr in text.
vromero@1591 651 * The content of text is split using the new line character as a pattern
vromero@1591 652 * and later the regExpr is seek in every split line. If a match is found,
vromero@1591 653 * the whole line is added to the result.
vromero@1591 654 */
vromero@1591 655 public static List<String> grep(String regExpr, String text) {
vromero@1591 656 return grep(regExpr, splitLines(text));
vromero@1591 657 }
vromero@1591 658
vromero@1591 659 public static List<String> grep(String regExpr, List<String> text) {
vromero@1591 660 List<String> result = new ArrayList<>();
vromero@1591 661 Pattern pattern = Pattern.compile(regExpr);
vromero@1591 662 for (String s : text) {
vromero@1591 663 if (pattern.matcher(s).find()) {
vromero@1591 664 result.add(s);
vromero@1591 665 }
vromero@1591 666 }
vromero@1591 667 return result;
vromero@1591 668 }
vromero@1591 669
vromero@1591 670 public static List<String> grep(String regExpr, File f)
vromero@1591 671 throws IOException {
vromero@1591 672 List<String> lines = Files.readAllLines(f.toPath(), defaultCharset);
vromero@1591 673 return grep(regExpr, lines);
vromero@1591 674 }
vromero@1591 675
vromero@1591 676 /**
vromero@1591 677 * A touch-like method.
vromero@1591 678 */
vromero@1591 679 public static boolean touch(String fileName) {
vromero@1591 680 File file = new File(fileName);
vromero@1591 681 return touch(file);
vromero@1591 682 }
vromero@1591 683
vromero@1591 684 public static boolean touch(File file) {
vromero@1591 685 if (file.exists()) {
vromero@1591 686 file.setLastModified(System.currentTimeMillis());
vromero@1591 687 return true;
vromero@1591 688 }
vromero@1591 689 return false;
vromero@1591 690 }
vromero@1591 691
vromero@1591 692 public static void createJavaFile(File outFile) throws IOException {
vromero@1591 693 createJavaFile(outFile, null);
vromero@1591 694 }
vromero@1591 695
vromero@1591 696 /**
vromero@1591 697 * A method for creating a valid but very simple java file.
vromero@1591 698 */
vromero@1591 699 public static void createJavaFile(File outFile, File superClass)
vromero@1591 700 throws IOException {
vromero@1591 701 String srcStr = "public class " + getSimpleName(outFile) + " ";
vromero@1591 702 if (superClass != null) {
vromero@1591 703 srcStr = srcStr.concat("extends " + getSimpleName(superClass) + " ");
vromero@1591 704 }
vromero@1591 705 srcStr = srcStr.concat("{}");
vromero@1591 706 try (PrintWriter ps = new PrintWriter(new FileWriter(outFile))) {
vromero@1591 707 ps.println(srcStr);
vromero@1591 708 }
vromero@1591 709 }
vromero@1591 710
vromero@1591 711 /**
vromero@1591 712 * Creates a java file name given its source.
vromero@1591 713 * The file is created in the working directory, creating a directory
vromero@1591 714 * tree if there is a package declaration.
vromero@1591 715 */
vromero@1591 716 public static void createJavaFileFromSource(String source) throws IOException {
vromero@1591 717 createJavaFileFromSource(null, source);
vromero@1591 718 }
vromero@1591 719
vromero@1591 720 /**
vromero@1591 721 * Creates a java file name given its source.
vromero@1591 722 * The file is created in the working directory, creating a directory
vromero@1591 723 * tree if there is a package declaration or the argument initialPath
vromero@1591 724 * has a valid path.
vromero@1591 725 *
vromero@1591 726 * e.i. if initialPath is foo/ and the source is:
vromero@1591 727 * package bar;
vromero@1591 728 *
vromero@1591 729 * public class bazz {}
vromero@1591 730 *
vromero@1591 731 * this method will create the file foo/bar/bazz.java in the working
vromero@1591 732 * directory.
vromero@1591 733 */
vromero@1591 734 public static void createJavaFileFromSource(Path initialPath,
vromero@1591 735 String source) throws IOException {
vromero@1591 736 String fileName = getJavaFileNameFromSource(source);
vromero@1591 737 String dirTree = getDirTreeFromSource(source);
vromero@1591 738 Path path = (dirTree != null) ?
vromero@1591 739 Paths.get(dirTree, fileName) :
vromero@1591 740 Paths.get(fileName);
vromero@1591 741 path = (initialPath != null) ?
vromero@1591 742 initialPath.resolve(path):
vromero@1591 743 path;
vromero@1591 744 writeFile(path, source);
vromero@1591 745 }
vromero@1591 746
vromero@1591 747 static Pattern publicClassPattern =
vromero@1591 748 Pattern.compile("public\\s+(?:class|enum|interface){1}\\s+(\\w+)");
vromero@1591 749 static Pattern packageClassPattern =
vromero@1591 750 Pattern.compile("(?:class|enum|interface){1}\\s+(\\w+)");
vromero@1591 751
vromero@1591 752 /**
vromero@1591 753 * Extracts the java file name from the class declaration.
vromero@1591 754 * This method is intended for simple files and uses regular expressions,
vromero@1591 755 * so comments matching the pattern can make the method fail.
vromero@1591 756 */
vromero@1591 757 private static String getJavaFileNameFromSource(String source) {
vromero@1591 758 String className = null;
vromero@1591 759 Matcher matcher = publicClassPattern.matcher(source);
vromero@1591 760 if (matcher.find()) {
vromero@1591 761 className = matcher.group(1) + ".java";
vromero@1591 762 } else {
vromero@1591 763 matcher = packageClassPattern.matcher(source);
vromero@1591 764 if (matcher.find()) {
vromero@1591 765 className = matcher.group(1) + ".java";
vromero@1591 766 } else {
vromero@1591 767 throw new AssertionError("Could not extract the java class " +
vromero@1591 768 "name from the provided source");
vromero@1591 769 }
vromero@1591 770 }
vromero@1591 771 return className;
vromero@1591 772 }
vromero@1591 773
vromero@1591 774 static Pattern packagePattern =
vromero@1591 775 Pattern.compile("package\\s+(((?:\\w+\\.)*)(?:\\w+))");
vromero@1591 776
vromero@1591 777 /**
vromero@1591 778 * Extracts the path from the package declaration if present.
vromero@1591 779 * This method is intended for simple files and uses regular expressions,
vromero@1591 780 * so comments matching the pattern can make the method fail.
vromero@1591 781 */
vromero@1591 782 private static String getDirTreeFromSource(String source) {
vromero@1591 783 Matcher matcher = packagePattern.matcher(source);
vromero@1591 784 return matcher.find() ?
vromero@1591 785 matcher.group(1).replace(".", File.separator) :
vromero@1591 786 null;
vromero@1591 787 }
vromero@1591 788
vromero@1591 789 /**
vromero@1591 790 * A method for creating a jar's manifest file with supplied data.
vromero@1591 791 */
vromero@1591 792 public static void mkManifestWithClassPath(String mainClass,
vromero@1591 793 String... classes) throws IOException {
vromero@1591 794 List <String> lines = new ArrayList<>();
vromero@1591 795
vromero@1591 796 StringBuilder sb = new StringBuilder("Class-Path: ".length() +
vromero@1591 797 classes[0].length()).append("Class-Path: ").append(classes[0]);
vromero@1591 798 for (int i = 1; i < classes.length; i++) {
vromero@1591 799 sb.append(" ").append(classes[i]);
vromero@1591 800 }
vromero@1591 801 lines.add(sb.toString());
vromero@1591 802 if (mainClass != null) {
vromero@1591 803 lines.add(new StringBuilder("Main-Class: ".length() +
vromero@1591 804 mainClass.length())
vromero@1591 805 .append("Main-Class: ")
vromero@1591 806 .append(mainClass).toString());
vromero@1591 807 }
vromero@1591 808 Files.write(Paths.get("MANIFEST.MF"), lines, null);
vromero@1591 809 }
vromero@1591 810
vromero@1591 811 /**
vromero@1591 812 * A utility method to obtain the file name.
vromero@1591 813 */
vromero@1591 814 static String getSimpleName(File inFile) {
vromero@1591 815 return inFile.toPath().getFileName().toString();
vromero@1591 816 }
vromero@1591 817
vromero@1591 818 /**
vromero@1591 819 * A method to write to a file, the directory tree is created if needed.
vromero@1591 820 */
vromero@1591 821 public static File writeFile(Path path, String body) throws IOException {
vromero@1591 822 File result;
vromero@1591 823 if (path.getParent() != null) {
vromero@1591 824 Files.createDirectories(path.getParent());
vromero@1591 825 }
vromero@1591 826 try (FileWriter out = new FileWriter(result = path.toAbsolutePath().toFile())) {
vromero@1591 827 out.write(body);
vromero@1591 828 }
vromero@1591 829 return result;
vromero@1591 830 }
vromero@1591 831
vromero@1591 832 public static File writeFile(String path, String body) throws IOException {
vromero@1591 833 return writeFile(Paths.get(path), body);
vromero@1591 834 }
vromero@1591 835
vromero@1591 836 /**
vromero@1591 837 * A rm-like method, the file is deleted only if it exists.
vromero@1591 838 */
vromero@1591 839 public static void rm(Path path) throws Exception {
vromero@1591 840 Files.deleteIfExists(path);
vromero@1591 841 }
vromero@1591 842
vromero@1591 843 public static void rm(String filename) throws Exception {
vromero@1591 844 rm(Paths.get(filename));
vromero@1591 845 }
vromero@1591 846
vromero@1591 847 public static void rm(File f) throws Exception {
vromero@1591 848 rm(f.toPath());
vromero@1591 849 }
vromero@1591 850
vromero@1591 851 /**
vromero@1591 852 * Copy source file to destination file.
vromero@1591 853 */
vromero@1591 854 public static void copyFile(File destfile, File srcfile)
vromero@1591 855 throws IOException {
vromero@1591 856 copyFile(destfile.toPath(), srcfile.toPath());
vromero@1591 857 }
vromero@1591 858
vromero@1591 859 public static void copyFile(Path destPath, Path srcPath)
vromero@1591 860 throws IOException {
vromero@1591 861 Files.createDirectories(destPath);
vromero@1591 862 Files.copy(srcPath, destPath, REPLACE_EXISTING);
vromero@1591 863 }
vromero@1591 864
vromero@1591 865 /**
vromero@1591 866 * Splits a String using the System's line separator character as splitting point.
vromero@1591 867 */
vromero@1591 868 public static List<String> splitLines(String lines) {
vromero@1591 869 return Arrays.asList(lines.split(lineSeparator));
vromero@1591 870 }
vromero@1591 871
vromero@1591 872 /**
vromero@1591 873 * Converts a String list into one String by appending the System's line separator
vromero@1591 874 * character after each component.
vromero@1591 875 */
vromero@1591 876 private static String listToString(List<String> lines) {
vromero@1591 877 StringBuilder sb = new StringBuilder();
vromero@1591 878 for (String s : lines) {
vromero@1591 879 sb.append(s).append(lineSeparator);
vromero@1591 880 }
vromero@1591 881 return sb.toString();
vromero@1591 882 }
vromero@1591 883
vromero@1591 884 /**
vromero@1591 885 * Class representing an in-memory java source file. It is able to extract
vromero@1591 886 * the file name from simple source codes using regular expressions.
vromero@1591 887 */
vromero@1591 888 public static class JavaSource extends SimpleJavaFileObject {
vromero@1591 889 String source;
vromero@1591 890 String name;
vromero@1591 891
vromero@1591 892 public JavaSource(String className, String source) {
vromero@1591 893 super(URI.create(className),
vromero@1591 894 JavaFileObject.Kind.SOURCE);
vromero@1591 895 this.name = className;
vromero@1591 896 this.source = source;
vromero@1591 897 }
vromero@1591 898
vromero@1591 899 public JavaSource(String source) {
vromero@1591 900 super(URI.create(getJavaFileNameFromSource(source)),
vromero@1591 901 JavaFileObject.Kind.SOURCE);
vromero@1591 902 this.name = getJavaFileNameFromSource(source);
vromero@1591 903 this.source = source;
vromero@1591 904 }
vromero@1591 905
vromero@1591 906 @Override
vromero@1591 907 public CharSequence getCharContent(boolean ignoreEncodingErrors) {
vromero@1591 908 return source;
vromero@1591 909 }
vromero@1591 910 }
vromero@1591 911 }

mercurial