windows-symbol-store-mojo

Maven plugin to wrap Microsoft's symstore.exe commands

symstore.exe information

Why might you need to set up a symbol server?

• Has QA ever given you a collection of mini dumps from unknown builds and you've spent most of a day searching for matching symbols?
• Do you produce a multitude of builds but don't know where to put pdb files?
• Do you get crash/process dumps from clients or other intenal teams when something goes wrong?

If you answered yes to any other the above questions, you probably should setup a symbol server. Besides, these days all the cool kids store their symbols from their msvc builds on a Microsoft Symbol Server.

The server itself isn't anything special, a UNC path that your build machines can write to is enough.

Remember that symstore.exe does not support symultaneous transactions from many instances and so you will need to accomodate this in your build system

This plugin attempts to wrap the common symstore.exe commands in maven mojo's for people who like to use maven for this sort of stuff.

Obviously, this plugin will only work on Windows.

Examples

Add Files

Files are defined by filesets. It is best to keep the filesets simple so that it can easily translate into a windows wildcard. This limits the number of discrete transactions.

<plugin>
	<groupId>org.tapley</groupId>
	<artifactId>windows-symbol-store</artifactId>
	<version>1.0.0-SNAPSHOT</version>
	<configuration>
		<symStorePath>C:\Program Files (x86)\Windows Kits\10\Debuggers\x64\symstore.exe</symStorePath>
		<repositoryPath>C:\temp\symbols</repositoryPath>
		<applicationName>test</applicationName>
		<fileSets>
			<fileSet>
				<directory>C:\Temp\binaries</directory>   
				<includes>
					<include>**/*.dll</include>
				</includes>
			</fileSet>
		</fileSets>
	</configuration>
	<executions>
		<execution>
			<id>mojo-AddSymbols</id>
			<phase>process-sources</phase>
			<goals>
				<goal>AddSymbols</goal>
			</goals>
		</execution>
	</executions>
</plugin>

Purge transactions after so many days

You might have multiple symbol stores, one for your released builds and one for your continuous integration builds. You may not want to keep your continuous integration symbols forever so this mojo will delete them after a configurable number of days.

<plugin>
	<groupId>org.tapley</groupId>
	<artifactId>windows-symbol-store</artifactId>
	<version>1.0.0-SNAPSHOT</version>
	<configuration>
		<symStorePath>C:\Program Files (x86)\Windows Kits\10\Debuggers\x64\symstore.exe</symStorePath>
		<repositoryPath>C:\temp\symbols</repositoryPath>
		<days>60</days>
	</configuration>
	<executions>
		<execution>
			<id>mojo-test</id>
			<phase>process-classes</phase>
			<goals>
				<goal>PurgeAfterDays</goal>
			</goals>
		</execution>
	</executions>
</plugin>