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
|
// Copyright 2018 The Bazel Authors. All rights reserved.
//
// 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.
package com.google.devtools.build.android;
import com.google.common.annotations.VisibleForTesting;
import com.google.common.base.Stopwatch;
import com.google.devtools.common.options.OptionsBase;
import com.google.devtools.common.options.OptionsParser;
import com.google.devtools.common.options.OptionsParsingException;
import com.google.devtools.common.options.ShellQuotedParamsFilePreProcessor;
import java.nio.file.FileSystems;
import java.nio.file.Path;
import java.util.logging.Level;
import java.util.logging.Logger;
/** Abstract base class containing helper methods and error handling for BusyBox actions. */
public abstract class AbstractBusyBoxAction {
private final OptionsParser optionsParser;
private final String description;
private final Stopwatch timer = Stopwatch.createUnstarted();
AbstractBusyBoxAction(OptionsParser optionsParser, String description) {
this.optionsParser = optionsParser;
this.description = description;
}
public void invoke(String[] args) throws Exception {
try {
invokeWithoutExit(args);
} catch (UserException | OptionsParsingException e) {
getLogger().severe(e.getMessage());
// In Bazel, users tend to assume that a stack trace indicates a bug in underlying Bazel code
// and ignore the content of the exception. If we know that the exception was actually their
// fault, we should just exit immediately rather than print a stack trace.
System.exit(1);
} catch (Exception e) {
getLogger().log(Level.SEVERE, "Unexpected", e);
throw e;
}
}
/** Invokes the action without calling System.exit or catching exceptions, for use in testing */
@VisibleForTesting
void invokeWithoutExit(String[] args) throws Exception {
timer.start();
optionsParser.enableParamsFileSupport(
new ShellQuotedParamsFilePreProcessor(FileSystems.getDefault()));
optionsParser.parse(args);
try (ScopedTemporaryDirectory scopedTmp = new ScopedTemporaryDirectory(description + "_tmp");
ExecutorServiceCloser executorService = ExecutorServiceCloser.createWithFixedPoolOf(15)) {
run(scopedTmp.getPath(), executorService);
}
logCompletion(description);
}
abstract void run(Path tmp, ExecutorServiceCloser executorService) throws Exception;
abstract Logger getLogger();
<T extends OptionsBase> T getOptions(Class<T> clazz) {
return optionsParser.getOptions(clazz);
}
/**
* Logs that this action or some portion of it completed successfully.
*
* @param completedAction the action that was completed, for example "parsing". A timestamp will
* be appended to this string.
*/
void logCompletion(String completedAction) {
getLogger()
.fine(String.format("%s finished at %sms", completedAction, timer.elapsed().toMillis()));
}
}
|
