annotate agent/src/jetbrains/buildServer/symbols/SymbolsIndexer.java @ 17:af87768a0724

minor
author Evgeniy.Koshkin
date Thu, 01 Aug 2013 17:22:53 +0400
parents 5856cab1ca05
children d1c5ce19d0f7
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2
c6ca0a26d93e initial implementation of agent-side symbol indexer
Evgeniy.Koshkin
parents:
diff changeset
1 package jetbrains.buildServer.symbols;
c6ca0a26d93e initial implementation of agent-side symbol indexer
Evgeniy.Koshkin
parents:
diff changeset
2
c6ca0a26d93e initial implementation of agent-side symbol indexer
Evgeniy.Koshkin
parents:
diff changeset
3 import com.intellij.execution.configurations.GeneralCommandLine;
c6ca0a26d93e initial implementation of agent-side symbol indexer
Evgeniy.Koshkin
parents:
diff changeset
4 import jetbrains.buildServer.ExecResult;
c6ca0a26d93e initial implementation of agent-side symbol indexer
Evgeniy.Koshkin
parents:
diff changeset
5 import jetbrains.buildServer.SimpleCommandLineProcessRunner;
3
53028ba390e0 improved build progress messages
Evgeniy.Koshkin
parents: 2
diff changeset
6 import jetbrains.buildServer.agent.*;
2
c6ca0a26d93e initial implementation of agent-side symbol indexer
Evgeniy.Koshkin
parents:
diff changeset
7 import jetbrains.buildServer.agent.artifacts.ArtifactsWatcher;
c6ca0a26d93e initial implementation of agent-side symbol indexer
Evgeniy.Koshkin
parents:
diff changeset
8 import jetbrains.buildServer.agent.impl.artifacts.ArtifactsBuilderAdapter;
c6ca0a26d93e initial implementation of agent-side symbol indexer
Evgeniy.Koshkin
parents:
diff changeset
9 import jetbrains.buildServer.agent.impl.artifacts.ArtifactsCollection;
c6ca0a26d93e initial implementation of agent-side symbol indexer
Evgeniy.Koshkin
parents:
diff changeset
10 import jetbrains.buildServer.agent.plugins.beans.PluginDescriptor;
c6ca0a26d93e initial implementation of agent-side symbol indexer
Evgeniy.Koshkin
parents:
diff changeset
11 import jetbrains.buildServer.util.EventDispatcher;
c6ca0a26d93e initial implementation of agent-side symbol indexer
Evgeniy.Koshkin
parents:
diff changeset
12 import jetbrains.buildServer.util.FileUtil;
c6ca0a26d93e initial implementation of agent-side symbol indexer
Evgeniy.Koshkin
parents:
diff changeset
13 import org.apache.log4j.Logger;
c6ca0a26d93e initial implementation of agent-side symbol indexer
Evgeniy.Koshkin
parents:
diff changeset
14 import org.jetbrains.annotations.NotNull;
c6ca0a26d93e initial implementation of agent-side symbol indexer
Evgeniy.Koshkin
parents:
diff changeset
15 import org.jetbrains.annotations.Nullable;
c6ca0a26d93e initial implementation of agent-side symbol indexer
Evgeniy.Koshkin
parents:
diff changeset
16
c6ca0a26d93e initial implementation of agent-side symbol indexer
Evgeniy.Koshkin
parents:
diff changeset
17 import java.io.File;
c6ca0a26d93e initial implementation of agent-side symbol indexer
Evgeniy.Koshkin
parents:
diff changeset
18 import java.io.IOException;
c6ca0a26d93e initial implementation of agent-side symbol indexer
Evgeniy.Koshkin
parents:
diff changeset
19 import java.util.*;
c6ca0a26d93e initial implementation of agent-side symbol indexer
Evgeniy.Koshkin
parents:
diff changeset
20
c6ca0a26d93e initial implementation of agent-side symbol indexer
Evgeniy.Koshkin
parents:
diff changeset
21 /**
c6ca0a26d93e initial implementation of agent-side symbol indexer
Evgeniy.Koshkin
parents:
diff changeset
22 * @author Evgeniy.Koshkin
c6ca0a26d93e initial implementation of agent-side symbol indexer
Evgeniy.Koshkin
parents:
diff changeset
23 */
c6ca0a26d93e initial implementation of agent-side symbol indexer
Evgeniy.Koshkin
parents:
diff changeset
24 public class SymbolsIndexer extends ArtifactsBuilderAdapter {
c6ca0a26d93e initial implementation of agent-side symbol indexer
Evgeniy.Koshkin
parents:
diff changeset
25
7
Evgeniy.Koshkin
parents: 5
diff changeset
26 private static final Logger LOG = Logger.getLogger(SymbolsIndexer.class);
2
c6ca0a26d93e initial implementation of agent-side symbol indexer
Evgeniy.Koshkin
parents:
diff changeset
27
c6ca0a26d93e initial implementation of agent-side symbol indexer
Evgeniy.Koshkin
parents:
diff changeset
28 public static final String PDB_FILE_EXTENSION = "pdb";
c6ca0a26d93e initial implementation of agent-side symbol indexer
Evgeniy.Koshkin
parents:
diff changeset
29
5
f7602ee7e8b1 implemented symbols index data publishing
Evgeniy.Koshkin
parents: 3
diff changeset
30 public static final String SYMBOLS_EXE = "JetBrains.CommandLine.Symbols.exe";
2
c6ca0a26d93e initial implementation of agent-side symbol indexer
Evgeniy.Koshkin
parents:
diff changeset
31 public static final String DUMP_SYMBOL_SIGN_CMD = "dumpSymbolSign";
c6ca0a26d93e initial implementation of agent-side symbol indexer
Evgeniy.Koshkin
parents:
diff changeset
32
c6ca0a26d93e initial implementation of agent-side symbol indexer
Evgeniy.Koshkin
parents:
diff changeset
33 @NotNull private final ArtifactsWatcher myArtifactsWatcher;
c6ca0a26d93e initial implementation of agent-side symbol indexer
Evgeniy.Koshkin
parents:
diff changeset
34 @NotNull private final File myNativeToolPath;
c6ca0a26d93e initial implementation of agent-side symbol indexer
Evgeniy.Koshkin
parents:
diff changeset
35 @Nullable private AgentRunningBuild myBuild;
c6ca0a26d93e initial implementation of agent-side symbol indexer
Evgeniy.Koshkin
parents:
diff changeset
36 @Nullable private Collection<File> mySymbolsToProcess;
c6ca0a26d93e initial implementation of agent-side symbol indexer
Evgeniy.Koshkin
parents:
diff changeset
37
c6ca0a26d93e initial implementation of agent-side symbol indexer
Evgeniy.Koshkin
parents:
diff changeset
38 public SymbolsIndexer(@NotNull final PluginDescriptor pluginDescriptor, @NotNull final EventDispatcher<AgentLifeCycleListener> agentDispatcher, @NotNull final ArtifactsWatcher artifactsWatcher) {
12
662a0be55de7 - source indexing works!
Evgeniy.Koshkin
parents: 11
diff changeset
39 myArtifactsWatcher = artifactsWatcher;
2
c6ca0a26d93e initial implementation of agent-side symbol indexer
Evgeniy.Koshkin
parents:
diff changeset
40 myNativeToolPath = new File(new File(pluginDescriptor.getPluginRoot(), "bin"), SYMBOLS_EXE);
12
662a0be55de7 - source indexing works!
Evgeniy.Koshkin
parents: 11
diff changeset
41
2
c6ca0a26d93e initial implementation of agent-side symbol indexer
Evgeniy.Koshkin
parents:
diff changeset
42 agentDispatcher.addListener(new AgentLifeCycleAdapter() {
c6ca0a26d93e initial implementation of agent-side symbol indexer
Evgeniy.Koshkin
parents:
diff changeset
43 @Override
c6ca0a26d93e initial implementation of agent-side symbol indexer
Evgeniy.Koshkin
parents:
diff changeset
44 public void buildStarted(@NotNull final AgentRunningBuild runningBuild) {
c6ca0a26d93e initial implementation of agent-side symbol indexer
Evgeniy.Koshkin
parents:
diff changeset
45 myBuild = runningBuild;
c6ca0a26d93e initial implementation of agent-side symbol indexer
Evgeniy.Koshkin
parents:
diff changeset
46 mySymbolsToProcess = new HashSet<File>();
c6ca0a26d93e initial implementation of agent-side symbol indexer
Evgeniy.Koshkin
parents:
diff changeset
47 }
c6ca0a26d93e initial implementation of agent-side symbol indexer
Evgeniy.Koshkin
parents:
diff changeset
48
c6ca0a26d93e initial implementation of agent-side symbol indexer
Evgeniy.Koshkin
parents:
diff changeset
49 @Override
5
f7602ee7e8b1 implemented symbols index data publishing
Evgeniy.Koshkin
parents: 3
diff changeset
50 public void afterAtrifactsPublished(@NotNull AgentRunningBuild build, @NotNull BuildFinishedStatus buildStatus) {
f7602ee7e8b1 implemented symbols index data publishing
Evgeniy.Koshkin
parents: 3
diff changeset
51 super.afterAtrifactsPublished(build, buildStatus);
12
662a0be55de7 - source indexing works!
Evgeniy.Koshkin
parents: 11
diff changeset
52 if (myBuild == null || mySymbolsToProcess == null) return;
3
53028ba390e0 improved build progress messages
Evgeniy.Koshkin
parents: 2
diff changeset
53 if(myBuild.getBuildFeaturesOfType(SymbolsConstants.BUILD_FEATURE_TYPE).isEmpty()) return;
53028ba390e0 improved build progress messages
Evgeniy.Koshkin
parents: 2
diff changeset
54
2
c6ca0a26d93e initial implementation of agent-side symbol indexer
Evgeniy.Koshkin
parents:
diff changeset
55 if (mySymbolsToProcess.isEmpty()) {
3
53028ba390e0 improved build progress messages
Evgeniy.Koshkin
parents: 2
diff changeset
56 myBuild.getBuildLogger().warning("Symbols weren't found in artifacts to be published.");
2
c6ca0a26d93e initial implementation of agent-side symbol indexer
Evgeniy.Koshkin
parents:
diff changeset
57 LOG.debug("Symbols weren't found in artifacts to be published.");
c6ca0a26d93e initial implementation of agent-side symbol indexer
Evgeniy.Koshkin
parents:
diff changeset
58 } else {
c6ca0a26d93e initial implementation of agent-side symbol indexer
Evgeniy.Koshkin
parents:
diff changeset
59 try {
12
662a0be55de7 - source indexing works!
Evgeniy.Koshkin
parents: 11
diff changeset
60 final File symbolSignaturesFile = dumpSymbolSignatures(mySymbolsToProcess, myBuild.getBuildTempDirectory(), myBuild.getBuildLogger());
5
f7602ee7e8b1 implemented symbols index data publishing
Evgeniy.Koshkin
parents: 3
diff changeset
61 if(symbolSignaturesFile.exists()){
f7602ee7e8b1 implemented symbols index data publishing
Evgeniy.Koshkin
parents: 3
diff changeset
62 myArtifactsWatcher.addNewArtifactsPath(symbolSignaturesFile + "=>" + ".teamcity/symbols");
f7602ee7e8b1 implemented symbols index data publishing
Evgeniy.Koshkin
parents: 3
diff changeset
63 }
2
c6ca0a26d93e initial implementation of agent-side symbol indexer
Evgeniy.Koshkin
parents:
diff changeset
64 } catch (IOException e) {
c6ca0a26d93e initial implementation of agent-side symbol indexer
Evgeniy.Koshkin
parents:
diff changeset
65 LOG.error("Error while dumping symbols/binaries signatures.", e);
5
f7602ee7e8b1 implemented symbols index data publishing
Evgeniy.Koshkin
parents: 3
diff changeset
66 myBuild.getBuildLogger().error("Error while dumping symbols/binaries signatures.");
f7602ee7e8b1 implemented symbols index data publishing
Evgeniy.Koshkin
parents: 3
diff changeset
67 myBuild.getBuildLogger().exception(e);
2
c6ca0a26d93e initial implementation of agent-side symbol indexer
Evgeniy.Koshkin
parents:
diff changeset
68 }
c6ca0a26d93e initial implementation of agent-side symbol indexer
Evgeniy.Koshkin
parents:
diff changeset
69 }
c6ca0a26d93e initial implementation of agent-side symbol indexer
Evgeniy.Koshkin
parents:
diff changeset
70 mySymbolsToProcess = null;
c6ca0a26d93e initial implementation of agent-side symbol indexer
Evgeniy.Koshkin
parents:
diff changeset
71 myBuild = null;
c6ca0a26d93e initial implementation of agent-side symbol indexer
Evgeniy.Koshkin
parents:
diff changeset
72 }
c6ca0a26d93e initial implementation of agent-side symbol indexer
Evgeniy.Koshkin
parents:
diff changeset
73 });
c6ca0a26d93e initial implementation of agent-side symbol indexer
Evgeniy.Koshkin
parents:
diff changeset
74 }
c6ca0a26d93e initial implementation of agent-side symbol indexer
Evgeniy.Koshkin
parents:
diff changeset
75
c6ca0a26d93e initial implementation of agent-side symbol indexer
Evgeniy.Koshkin
parents:
diff changeset
76 @Override
c6ca0a26d93e initial implementation of agent-side symbol indexer
Evgeniy.Koshkin
parents:
diff changeset
77 public void afterCollectingFiles(@NotNull List<ArtifactsCollection> artifacts) {
c6ca0a26d93e initial implementation of agent-side symbol indexer
Evgeniy.Koshkin
parents:
diff changeset
78 super.afterCollectingFiles(artifacts);
12
662a0be55de7 - source indexing works!
Evgeniy.Koshkin
parents: 11
diff changeset
79 if(myBuild == null || mySymbolsToProcess == null) return;
2
c6ca0a26d93e initial implementation of agent-side symbol indexer
Evgeniy.Koshkin
parents:
diff changeset
80 if(myBuild.getBuildFeaturesOfType(SymbolsConstants.BUILD_FEATURE_TYPE).isEmpty()){
3
53028ba390e0 improved build progress messages
Evgeniy.Koshkin
parents: 2
diff changeset
81 myBuild.getBuildLogger().warning(SymbolsConstants.BUILD_FEATURE_TYPE + " build feature disabled. No indexing performed.");
2
c6ca0a26d93e initial implementation of agent-side symbol indexer
Evgeniy.Koshkin
parents:
diff changeset
82 LOG.debug(SymbolsConstants.BUILD_FEATURE_TYPE + " build feature disabled. No indexing performed.");
c6ca0a26d93e initial implementation of agent-side symbol indexer
Evgeniy.Koshkin
parents:
diff changeset
83 return;
c6ca0a26d93e initial implementation of agent-side symbol indexer
Evgeniy.Koshkin
parents:
diff changeset
84 }
5
f7602ee7e8b1 implemented symbols index data publishing
Evgeniy.Koshkin
parents: 3
diff changeset
85 LOG.debug(SymbolsConstants.BUILD_FEATURE_TYPE + " build feature enabled. Searching for suitable files.");
12
662a0be55de7 - source indexing works!
Evgeniy.Koshkin
parents: 11
diff changeset
86 Collection<File> pdbFiles = getArtifactPathsByFileExtension(artifacts, PDB_FILE_EXTENSION);
662a0be55de7 - source indexing works!
Evgeniy.Koshkin
parents: 11
diff changeset
87 final PdbFilePatcher pdbFilePatcher = new PdbFilePatcher(myBuild.getBuildTempDirectory(), new SrcSrvStreamProvider(myBuild.getBuildId(), myBuild.getCheckoutDirectory()));
662a0be55de7 - source indexing works!
Evgeniy.Koshkin
parents: 11
diff changeset
88 for(File pdbFile : pdbFiles){
662a0be55de7 - source indexing works!
Evgeniy.Koshkin
parents: 11
diff changeset
89 try {
662a0be55de7 - source indexing works!
Evgeniy.Koshkin
parents: 11
diff changeset
90 myBuild.getBuildLogger().message("Indexing sources appeared in file " + pdbFile.getAbsolutePath());
662a0be55de7 - source indexing works!
Evgeniy.Koshkin
parents: 11
diff changeset
91 pdbFilePatcher.patch(pdbFile);
662a0be55de7 - source indexing works!
Evgeniy.Koshkin
parents: 11
diff changeset
92 mySymbolsToProcess.add(pdbFile);
662a0be55de7 - source indexing works!
Evgeniy.Koshkin
parents: 11
diff changeset
93 } catch (Throwable e) {
662a0be55de7 - source indexing works!
Evgeniy.Koshkin
parents: 11
diff changeset
94 LOG.error("Error occurred while patching symbols file " + pdbFile, e);
662a0be55de7 - source indexing works!
Evgeniy.Koshkin
parents: 11
diff changeset
95 myBuild.getBuildLogger().error("Error occurred while patching symbols file " + pdbFile);
662a0be55de7 - source indexing works!
Evgeniy.Koshkin
parents: 11
diff changeset
96 myBuild.getBuildLogger().exception(e);
662a0be55de7 - source indexing works!
Evgeniy.Koshkin
parents: 11
diff changeset
97 }
662a0be55de7 - source indexing works!
Evgeniy.Koshkin
parents: 11
diff changeset
98 }
2
c6ca0a26d93e initial implementation of agent-side symbol indexer
Evgeniy.Koshkin
parents:
diff changeset
99 }
c6ca0a26d93e initial implementation of agent-side symbol indexer
Evgeniy.Koshkin
parents:
diff changeset
100
c6ca0a26d93e initial implementation of agent-side symbol indexer
Evgeniy.Koshkin
parents:
diff changeset
101 private Collection<File> getArtifactPathsByFileExtension(List<ArtifactsCollection> artifactsCollections, String fileExtension){
c6ca0a26d93e initial implementation of agent-side symbol indexer
Evgeniy.Koshkin
parents:
diff changeset
102 final Collection<File> result = new HashSet<File>();
c6ca0a26d93e initial implementation of agent-side symbol indexer
Evgeniy.Koshkin
parents:
diff changeset
103 for(ArtifactsCollection artifactsCollection : artifactsCollections){
c6ca0a26d93e initial implementation of agent-side symbol indexer
Evgeniy.Koshkin
parents:
diff changeset
104 if(artifactsCollection.isEmpty()) continue;
c6ca0a26d93e initial implementation of agent-side symbol indexer
Evgeniy.Koshkin
parents:
diff changeset
105 for (File artifact : artifactsCollection.getFilePathMap().keySet()){
c6ca0a26d93e initial implementation of agent-side symbol indexer
Evgeniy.Koshkin
parents:
diff changeset
106 if(FileUtil.getExtension(artifact.getPath()).equalsIgnoreCase(fileExtension))
c6ca0a26d93e initial implementation of agent-side symbol indexer
Evgeniy.Koshkin
parents:
diff changeset
107 result.add(artifact);
c6ca0a26d93e initial implementation of agent-side symbol indexer
Evgeniy.Koshkin
parents:
diff changeset
108 }
c6ca0a26d93e initial implementation of agent-side symbol indexer
Evgeniy.Koshkin
parents:
diff changeset
109 }
c6ca0a26d93e initial implementation of agent-side symbol indexer
Evgeniy.Koshkin
parents:
diff changeset
110 return result;
c6ca0a26d93e initial implementation of agent-side symbol indexer
Evgeniy.Koshkin
parents:
diff changeset
111 }
c6ca0a26d93e initial implementation of agent-side symbol indexer
Evgeniy.Koshkin
parents:
diff changeset
112
3
53028ba390e0 improved build progress messages
Evgeniy.Koshkin
parents: 2
diff changeset
113 private File dumpSymbolSignatures(Collection<File> files, File targetDir, BuildProgressLogger buildLogger) throws IOException {
2
c6ca0a26d93e initial implementation of agent-side symbol indexer
Evgeniy.Koshkin
parents:
diff changeset
114 final File tempFile = FileUtil.createTempFile(targetDir, "symbol-signatures-", ".xml", false);
12
662a0be55de7 - source indexing works!
Evgeniy.Koshkin
parents: 11
diff changeset
115 runNativeTool(DUMP_SYMBOL_SIGN_CMD, files, tempFile, buildLogger);
2
c6ca0a26d93e initial implementation of agent-side symbol indexer
Evgeniy.Koshkin
parents:
diff changeset
116 return tempFile;
c6ca0a26d93e initial implementation of agent-side symbol indexer
Evgeniy.Koshkin
parents:
diff changeset
117 }
c6ca0a26d93e initial implementation of agent-side symbol indexer
Evgeniy.Koshkin
parents:
diff changeset
118
12
662a0be55de7 - source indexing works!
Evgeniy.Koshkin
parents: 11
diff changeset
119 private void runNativeTool(String cmd, Collection<File> files, File output, BuildProgressLogger buildLogger){
2
c6ca0a26d93e initial implementation of agent-side symbol indexer
Evgeniy.Koshkin
parents:
diff changeset
120 final GeneralCommandLine commandLine = new GeneralCommandLine();
c6ca0a26d93e initial implementation of agent-side symbol indexer
Evgeniy.Koshkin
parents:
diff changeset
121 commandLine.setExePath(myNativeToolPath.getPath());
c6ca0a26d93e initial implementation of agent-side symbol indexer
Evgeniy.Koshkin
parents:
diff changeset
122 commandLine.addParameter(cmd);
c6ca0a26d93e initial implementation of agent-side symbol indexer
Evgeniy.Koshkin
parents:
diff changeset
123 commandLine.addParameter(String.format("/o=\"%s\"", output.getPath()));
c6ca0a26d93e initial implementation of agent-side symbol indexer
Evgeniy.Koshkin
parents:
diff changeset
124 for(File file : files){
c6ca0a26d93e initial implementation of agent-side symbol indexer
Evgeniy.Koshkin
parents:
diff changeset
125 commandLine.addParameter(file.getPath());
c6ca0a26d93e initial implementation of agent-side symbol indexer
Evgeniy.Koshkin
parents:
diff changeset
126 }
5
f7602ee7e8b1 implemented symbols index data publishing
Evgeniy.Koshkin
parents: 3
diff changeset
127 buildLogger.message(String.format("Running command %s", commandLine.getCommandLineString()));
2
c6ca0a26d93e initial implementation of agent-side symbol indexer
Evgeniy.Koshkin
parents:
diff changeset
128 final ExecResult execResult = SimpleCommandLineProcessRunner.runCommand(commandLine, null);
5
f7602ee7e8b1 implemented symbols index data publishing
Evgeniy.Koshkin
parents: 3
diff changeset
129 buildLogger.message(execResult.getStdout());
2
c6ca0a26d93e initial implementation of agent-side symbol indexer
Evgeniy.Koshkin
parents:
diff changeset
130 if (execResult.getExitCode() == 0) return;
5
f7602ee7e8b1 implemented symbols index data publishing
Evgeniy.Koshkin
parents: 3
diff changeset
131 buildLogger.warning(String.format("%s ends with non-zero exit code.", SYMBOLS_EXE));
f7602ee7e8b1 implemented symbols index data publishing
Evgeniy.Koshkin
parents: 3
diff changeset
132 buildLogger.warning(execResult.getStderr());
14
5856cab1ca05 logged exception end output of the native symbols utility
Evgeniy.Koshkin
parents: 12
diff changeset
133 buildLogger.warning(execResult.getStdout());
5856cab1ca05 logged exception end output of the native symbols utility
Evgeniy.Koshkin
parents: 12
diff changeset
134 buildLogger.exception(execResult.getException());
2
c6ca0a26d93e initial implementation of agent-side symbol indexer
Evgeniy.Koshkin
parents:
diff changeset
135 }
c6ca0a26d93e initial implementation of agent-side symbol indexer
Evgeniy.Koshkin
parents:
diff changeset
136 }