";
+ var buildSummaryHtml = "
";
+ buildSummaryHtml += "
Build Summary
Number of files being built: " + (counter-1);
+ buildSummaryHtml += "
" + tableHtml + "
";
+ mainHtml += versionInfoHtml;
+ mainHtml += jenkinsBuildHtml;
+ mainHtml += buildSummaryHtml;
+ mainHtml += "
";
+ var rowHtml = tr;
+ rowHtml += "| " + counter + " | " + cRecord.file;
+ var dependencySet = dependencySetCache[cRecord.file];
+ if (dependencySet != null)
+ {
+ var depId = "dep_" + counter;
+ var showDepId = "showDep_" + counter;
+ rowHtml += "";
+ rowHtml += " ";
+ rowHtml += " ";
+ for (q in dependencySet)
+ {
+ rowHtml += "- ";
+ var dependency = dependencySet[q];
+ if (dependency.resolved)
+ rowHtml += dependency.file;
+ else
+ rowHtml += dependency.lname;
+ rowHtml += " " + dependency.category + "";
+ rowHtml += "
";
+ }
+ rowHtml += " ";
+ rowHtml += " Show Dependencies";
+ rowHtml += " | ";
+ /** Generate a HTML column to display the Git commit hash value for each file */
+ rowHtml += "" + cRecord.gitHash + " | ";
+ var cRecordCount = 0;
+ for (y in cRecord.executors)
+ {
+ rowHtml += "" + cRecord.executors[y] + " | " + cRecord.rcs[y] + " | " + cRecord.datasets[y] + " | ";
+ rowHtml += cRecord.outputs[y] + " | " + cRecord.deployTypes[y] + " | " + cRecord.logs[y] + " | ";
+ if (cRecordCount < cRecord.executors.length)
+ rowHtml += "
" + tr;
+ cRecordCount++;
+ }
+ rowHtml += "";
+ return rowHtml;
+}
\ No newline at end of file
diff --git a/Build/BuildReport/DefaultTheme.css b/Build/BuildReport/DefaultTheme.css
new file mode 100644
index 00000000..d8383989
--- /dev/null
+++ b/Build/BuildReport/DefaultTheme.css
@@ -0,0 +1,44 @@
+body {
+ font: 12px Arial, sans-serif;
+}
+
+table {
+ border-collapse: collapse;
+}
+
+table, th, td {
+ border: 1px solid #A9A9A9;
+}
+
+th, td {
+ padding: 10px;
+ text-align: left;
+}
+
+tr.even {
+ background-color: #f2f2f2
+}
+
+th {
+ background-color: #81C4E8;
+ color: white;
+}
+
+td.label {
+ font-weight: bold;
+}
+
+.bottomRight {
+ float:right;
+ text-align:right;
+ font: 10px Arial, sans-serif;
+}
+
+.dep {
+ font: 11px Arial, sans-serif;
+}
+
+.depType {
+ font: 9px Arial, sans-serif;
+ background-color: #81C4E8;
+}
\ No newline at end of file
diff --git a/Build/BuildReport/GitHashRecord.java b/Build/BuildReport/GitHashRecord.java
new file mode 100644
index 00000000..0ffbe700
--- /dev/null
+++ b/Build/BuildReport/GitHashRecord.java
@@ -0,0 +1,90 @@
+/*******************************************************************************
+ * Licensed Materials - Property of IBM
+ * (c) Copyright IBM Corporation 2018. All Rights Reserved.
+ *
+ * Note to U.S. Government Users Restricted Rights:
+ * Use, duplication or disclosure restricted by GSA ADP Schedule
+ * Contract with IBM Corp.
+ *******************************************************************************/
+package com.ibm.team.dbb.build.ext.git.report;
+
+import com.ibm.json.java.JSONObject;
+import com.ibm.team.dbb.build.report.records.Record;
+
+/**
+ * Sample build report record to store Git hash information for
+ * each file
+ *
+ */
+public class GitHashRecord extends Record
+{
+ public static final String PROP_FILE_PATH = "filePath";
+ public static final String PROP_COMMIT_HASH_VALUE = "commitHashValue";
+
+ private String filePath;
+ private String commitHashValue;
+
+ /**
+ * Constructor
+ */
+ public GitHashRecord(String id)
+ {
+ super(id, GitRecordFactory.TYPE_GIT_HASH);
+ }
+
+ /**
+ * Return the path of the file
+ * @return the path of the file
+ */
+ public String getFilePath()
+ {
+ return filePath;
+ }
+
+ /**
+ * Set the path of the file
+ * @param filePath the path of the file
+ */
+ public void setFilePath(String filePath)
+ {
+ this.filePath = filePath;
+ }
+
+ /**
+ * Return the hash value of the file
+ * @return the hash value of the file
+ */
+ public String getCommitHashValue()
+ {
+ return commitHashValue;
+ }
+
+ /**
+ * Set the hash value of the file
+ * @param commitHashValue the hash value of the file
+ */
+ public void setCommitHashValue(String commitHashValue)
+ {
+ this.commitHashValue = commitHashValue;
+ }
+
+ @Override
+ public JSONObject toJSON()
+ {
+ JSONObject jsonObj = super.toJSON();
+ jsonObj.put(PROP_FILE_PATH, filePath);
+ jsonObj.put(PROP_COMMIT_HASH_VALUE, commitHashValue);
+ return jsonObj;
+ }
+
+ @Override
+ public Record parse(JSONObject jsonObj)
+ {
+ Record record = super.parse(jsonObj);
+ filePath = (String)jsonObj.get(PROP_FILE_PATH);
+ commitHashValue = (String)jsonObj.get(PROP_COMMIT_HASH_VALUE);
+ return record;
+ }
+
+
+}
diff --git a/Build/BuildReport/GitRecordFactory.java b/Build/BuildReport/GitRecordFactory.java
new file mode 100644
index 00000000..159dbf86
--- /dev/null
+++ b/Build/BuildReport/GitRecordFactory.java
@@ -0,0 +1,52 @@
+/*******************************************************************************
+ * Licensed Materials - Property of IBM
+ * (c) Copyright IBM Corporation 2018. All Rights Reserved.
+ *
+ * Note to U.S. Government Users Restricted Rights:
+ * Use, duplication or disclosure restricted by GSA ADP Schedule
+ * Contract with IBM Corp.
+ *******************************************************************************/
+package com.ibm.team.dbb.build.ext.git.report;
+
+import com.ibm.json.java.JSONObject;
+import com.ibm.team.dbb.build.report.records.AbstractRecordFactory;
+import com.ibm.team.dbb.build.report.records.IRecordFactory;
+import com.ibm.team.dbb.build.report.records.Record;
+
+/**
+ * The factory to create GIT record.
+ *
+ */
+public class GitRecordFactory extends AbstractRecordFactory implements IRecordFactory
+{
+ public static final String TYPE_GIT_HASH = "GIT_HASH";
+
+
+ /**
+ * Create a record with the specified ID and type.
+ */
+ @Override
+ public Record createRecord(String id, String type)
+ {
+ if (TYPE_GIT_HASH.equals(type))
+ return new GitHashRecord(id);
+ return null;
+ }
+
+ @Override
+ protected Record doParseRecord(JSONObject jsonObj, String id, String type)
+ {
+ Record record = createRecord(id, type);
+ if (record != null)
+ record.parse(jsonObj);
+ return record;
+ }
+
+ @Override
+ public String[] getAllSupportedTypes()
+ {
+ return new String[] {TYPE_GIT_HASH};
+ }
+
+
+}
diff --git a/Build/BuildReport/README.md b/Build/BuildReport/README.md
new file mode 100644
index 00000000..8a701831
--- /dev/null
+++ b/Build/BuildReport/README.md
@@ -0,0 +1,99 @@
+# Build Report Sample
+The following sample shows how to extend build report to provide additional functionality.
+
+## Requirement
+Record the Git commit hash value for each file being built in the build report.
+
+## Background
+DBB provides APIs to generate a build report to summarize what files being built. User can also use the APIs to extend the build report to add additional information. In this article, we will show you the steps to extend the build report APIs to provide git hash value of each file being built.
+
+## Solution
+We want to extend the build report to show additional column for displaying the commit hash value of each file
+
+[[images/CustomBuildReport.png|Custom Build Report]]
+
+We will use the sample Mortgage Application shipped with DBB to demonstrate the steps. Here is the outline of the steps:
+1. Creating GitHashRecord.java and GitRecordFactory.java
+2. Retrieving and recording git hash value for each file in buildReport.json.
+3. Registering GitRecordFactory.
+3. Verifying GitHashRecord in buildReport.json.
+4. Rendering Git hash in buildReport.html.
+
+### Creating GitHashRecord.java and GitRecordFactory.java
+The purpose of GitHashRecord is to store the Git hash value for each file. The GitRecordFactory is used by DBB to create individual GitHashRecord that can be stored in the build report.
+1. Create a Java project.
+2. Set the classpath to include necessary DBB jar files.
+3. Create a GitHashRecord.java that contains 2 fields: filePath and commitHashValue, and provide setters and getters for these 2 fields, see attachment GitHashRecord.java.
+4. Create a GitRecordFactory.java to create the GitHashRecord, see attachment GitRecordFactory.java.
+5. Export the Java project as a jar file and FTP to the buildToolkit, and modify the classpath of the build accordingly.
+
+### Retrieving and Recording Git Hash Value in BuildReport.json
+1. The easy way to retrieve the Git commit hash value for each file is to use Git command "git ls-file". Add the following sample code in the beginning of the build script:
+
+> //Generate a cache to store git hash for each file
+> def fileGitHashCache = [:]
+> def command = "git ls-files -s"
+> def commandOut = new StringBuffer()
+> def commandErr = new StringBuffer()
+> def process = command.execute(null, new File(properties.sourceDir))
+> process.waitForProcessOutput commandOut, commandErr
+> if (commandErr.toString().readLines().size() > 0)
+> println("Error executing command $command: ${commandErr.toString()}")
+> else if (commandOut.toString().readLines().size() > 0)
+> {
+> commandOut.toString().eachLine { line ->
+> def (id, hash, eol, file) = line.tokenize()
+> fileGitHashCache[file] = hash
+> }
+> }
+> def commandRC = process.exitValue()
+
+2. As we compile each file, we will find the hash value and create a GitHashRecord to store this information in the build report.
+
+> buildFiles.each { file ->
+> run(new File(scriptName), [file] as String[])
+> processCounter++
+> def gitHashValue = fileGitHashCache[file]
+> def gitHashRecord = new GitHashRecord()
+> gitHashRecord.setFilePath(file)
+> gitHashRecord.setCommitHashValue(gitHashValue)
+> BuildReportFactory.getBuildReport().addRecord(gitHashRecord)
+> }
+
+### Registering GitRecordFactory
+In order for DBB to record and save the record in buildReport.json, we need to register the new GitRecordFactory. In the Jenkins project, add the following Java parameters:
+
+> -Ddbb.report.record.factories=com.ibm.team.dbb.build.ext.jenkins.report.JenkinsRecordFactory,com.ibm.team.dbb.build.ext.git.report.GitRecordFactory`
+
+### Verifying GitHashRecord in buildReport.json
+Request a build and go to the build result, select to view the build report data, you should be able to see the sample git hash record for each file being built.
+
+> "filePath":"MortgageApplication\/bms\/epsmlis.bms",
+> "commitHashValue":"2d9fd4aecbbab3a79b615b778bc48235d4272239",
+> "id":null,
+> "type":"GIT_HASH"
+
+### Rendering Git hash in buildReport.html
+For this step, we need to create a JavaScript that is similar to the default BuildSummaryRender.js. Add the following code to render the Git Hash value stored in the buildReport.json.
+1. In the render() method, add the following script to store the git hash value to the record
+
+> else if (record.type == 'GIT_HASH')
+> {
+> cRecord.gitHash = record.commitHashValue
+> }
+
+2. In the renderExec(), add the following script to render the git hash value as HTML
+
+> rowHtml += "