2 |
--------------------------------------------------------------------------------
/splunk-devops/src/test/resources/com/splunk/splunkjenkins/CoverageMetricTest/jobs/JaCoCo/workspace/java/com/mycompany/App.java:
--------------------------------------------------------------------------------
1 | package com.mycompany;
2 |
3 | /**
4 | * Hello world!
5 | */
6 | public class App {
7 | public String getText() {
8 | return "hello";
9 | }
10 |
11 | public int getResult(boolean even) {
12 | if (even) {
13 | return 2;
14 | } else {
15 | return 1;
16 | }
17 | }
18 |
19 | public boolean isOk() {
20 | return false;
21 | }
22 |
23 | public static class Util {
24 | public static int calc(int a, int b) {
25 | return a + b;
26 | }
27 | }
28 | }
29 |
--------------------------------------------------------------------------------
/splunk-devops/src/main/resources/com/splunk/splunkjenkins/SplunkJenkinsInstallation/help-httpInputConfig.html:
--------------------------------------------------------------------------------
1 |
3 | The event can be turned off by setting it to Disabled.
4 |
5 | Index is a data repository in Splunk, you can set a different data retention policy and access privileges for
6 | each index in Splunk.
7 |
8 | Source Type is used by Splunk to determine how incoming data is formatted.
9 |
It is recommended to use the plugin's default config 12 | if you are using Splunk App for Jenkins as the App expects a certain metadata format. 13 |
14 | 15 |
2 | 
9 |
14 |
--------------------------------------------------------------------------------
/splunk-devops/src/main/resources/com/splunk/splunkjenkins/SplunkJenkinsInstallation/help-host.html:
--------------------------------------------------------------------------------
1 | You need enable HTTP Event Collector in Splunk. 3 | To enable it, go to Splunk Settings > Data inputs > HTTP Event Collector. 4 | Then click the Global Settings button in the upper-right corner. 5 | You can configure HTTP Port number and SSL on the Global Settings. 6 | Port is 8088, and SSL is enabled by default. 7 |8 |
9 | 10 | See more details at HTTP Event Collector 11 | walk through 12 |
13 |
2 |
15 |
--------------------------------------------------------------------------------
/splunk-devops/src/main/resources/com/splunk/splunkjenkins/SplunkJenkinsInstallation/help-metaDataConfig.html:
--------------------------------------------------------------------------------
1 | The Splunk Indexer hostname or IP address, multiple hosts separated by comma. Example: 3 | "192.168.1.4,192.168.1.5"
4 |-
5 |
- For Splunk cloud user, the host name is something like http-inputs-xx.splunkcloud.com or 6 | http-inputs-xx.cloud.splunk.com, and HTTP Input Port is 443 7 | 8 |
- For Splunk enterprise user, the host name is the indexer host name, and HTTP Input Port is 8088 by default 9 | 10 |
2 |
18 |
--------------------------------------------------------------------------------
/splunk-devops/src/main/java/com/splunk/splunkjenkins/utils/CoverageDetailJsonSerializer.java:
--------------------------------------------------------------------------------
1 | package com.splunk.splunkjenkins.utils;
2 |
3 | import com.splunk.splunkjenkins.model.CoverageMetricsAdapter;
4 | import shaded.splk.com.google.gson.JsonElement;
5 | import shaded.splk.com.google.gson.JsonSerializationContext;
6 | import shaded.splk.com.google.gson.JsonSerializer;
7 |
8 | import java.lang.reflect.Type;
9 |
10 | public class CoverageDetailJsonSerializer implements JsonSerializerSpecify index, host, source, soucetype for the events.
3 | index is a data repository in Splunk, please create the 4 indexes in Splunk: 4 | 5 | jenkins, jenkins_statistics, jenkins_console and jenkins_artifact 6 | 7 | 8 |
9 | host is used to identify which Jenkins master is the source of the data.
10 | the metadata can be used in Splunk query language such as
11 | index="jenkins" host="servername" sourcetype="json:jenkins"
12 |
15 | See more details 16 |
17 |
2 | 
6 |
20 |
--------------------------------------------------------------------------------
/splunk-devops/src/main/resources/com/splunk/splunkjenkins/SplunkArtifactNotifier/help-publishFromSlave.html:
--------------------------------------------------------------------------------
1 | You can find the HTTP Event Collector Token in Splunk, go to Splunk Settings > Data inputs > HTTP Event 3 | Collector. 4 |
5 |
6 | 7 | See more details at HTTP Event Collector 8 | walk through 9 |
10 |To verify the token via curl command
11 |
12 | hec_host=<splunk-host>
13 | hec_port=8088
14 | hec_token=<splunk-token>
15 | curl -k "https://${hec_host}:${hec_port}/services/collector/event" -H "Authorization: Splunk ${hec_token}" -d \
16 | '{"host":"test-host","index":"jenkins_console","sourcetype":"json:jenkins","source":"logger://dummy","event":{"level":"INFO","log_source":"cmdline","message":"Test HEC"}}'
17 |
18 |
19 |
2 | Publish log files directly from the slave, instead of proxy for the process to the master.
3 | When publish from slave is selected, Jenkins master will transfer the plugin and its dependence to slave and
4 | initiate
5 | the publishing process from the slave.
6 | Take below into consideration:
7 |
27 |
--------------------------------------------------------------------------------
/splunk-devops/src/test/java/com/splunk/splunkjenkins/BaseTest.java:
--------------------------------------------------------------------------------
1 | package com.splunk.splunkjenkins;
2 |
3 | import com.splunk.splunkjenkins.utils.SplunkLogService;
4 | import org.junit.After;
5 | import org.junit.Before;
6 | import org.junit.Rule;
7 | import org.jvnet.hudson.test.JenkinsRule;
8 |
9 | import static com.splunk.splunkjenkins.SplunkConfigUtil.checkTokenAvailable;
10 | import static com.splunk.splunkjenkins.utils.LogEventHelper.getDefaultDslScript;
11 |
12 | public class BaseTest {
13 | @Rule
14 | public JenkinsRule j = new JenkinsRule();
15 |
16 | @Before
17 | public void setUp() throws Exception {
18 | org.junit.Assume.assumeTrue(checkTokenAvailable());
19 | SplunkJenkinsInstallation.get().setScriptContent(getDefaultDslScript());
20 | SplunkJenkinsInstallation.get().updateCache();
21 | }
22 |
23 | @After
24 | public void tearDown() {
25 | SplunkLogService.getInstance().stopWorker();
26 | SplunkLogService.getInstance().releaseConnection();
27 | }
28 | }
29 |
--------------------------------------------------------------------------------
/splunk-devops/src/main/java/com/splunk/splunkjenkins/utils/SpecialDoubleAdapter.java:
--------------------------------------------------------------------------------
1 | package com.splunk.splunkjenkins.utils;
2 |
3 |
4 | import shaded.splk.com.google.gson.TypeAdapter;
5 | import shaded.splk.com.google.gson.stream.JsonReader;
6 | import shaded.splk.com.google.gson.stream.JsonToken;
7 | import shaded.splk.com.google.gson.stream.JsonWriter;
8 |
9 | import java.io.IOException;
10 |
11 | public class SpecialDoubleAdapter extends TypeAdapter-
8 |
- slave and master load 9 | 10 |
- 11 | log file size 12 | 13 |
- 14 | slave type, long lived slave or one time use slave 15 | 16 |
-
20 |
- a. if log files size is less than 5MB, publish from master is preferred. 21 |
- b. if Splunk instance is in an isolated network which is not reachable from slave, you need publish from 22 | master. 23 | 24 |
2 | Check Regular 3 | Expression to select which build will be ignored for monitoring. Build url matches 4 | the pattern will be ignored, for example: 5 |
(?:backgroundJobName|adhocJobName|tempJobName)
6 | will match backgroundJobName, backgroundJobNameBlah, blahbackgroundJobName
7 |^(?:backgroundJobName|adhocJobName|tempJobName)$
8 | will match backgroundJobName but neither backgroundJobNameBlah nor blahbackgroundJobName
9 || (?:X) | 12 |X, as a non-capturing group | 13 |
| ^ | 16 |The beginning of a line | 17 |
| $ | 20 |The end of a line | 21 |
| X|Y | 24 |Either X or Y | 25 |
| \w | 28 |A word character: [a-zA-Z_0-9] | 29 |
| Build Report | 4 |Junit or other Test Reports sent by calling "send(message)" DSL script 5 | | 6 |
| Build Event | 9 |Sent when job are started and completed 10 | | 11 |
| Queue Information | 14 |Basic queue information and Jenkins health metrics 15 | | 16 |
| Console Log | 19 |Build console log, slave log and Jenkins master log (jenkins.log) 20 | | 21 |
| Log File | 24 |Artifact contents, send by calling "archive(includes, excludes)" DSL script 25 | | 26 |
| Slave Information | 29 |The slave(agent) monitor data 30 | | 31 |
| Jenkins Config | 34 |The contents of Jenkins configuration items, e.g. config.xml, sent when the config file get updated. 35 | | 36 |
true if need spit the contents line by line if raw event not supported;
29 | * false otherwise.
30 | */
31 | public boolean needSplit() {
32 | return needSplit;
33 | }
34 |
35 | /**
36 | * @param suffix the config metadata, can be either index, source or sourcetype
37 | * @return return name.suffix
38 | */
39 | public String getKey(String suffix) {
40 | return this.name().toLowerCase() + "." + suffix;
41 | }
42 | }
43 |
--------------------------------------------------------------------------------
/splunk-devops/src/test/java/com/splunk/splunkjenkins/JdkSplunkLogHandlerTest.java:
--------------------------------------------------------------------------------
1 | package com.splunk.splunkjenkins;
2 |
3 | import org.junit.Before;
4 | import org.junit.Test;
5 |
6 | import java.util.UUID;
7 | import java.util.logging.Handler;
8 | import java.util.logging.Logger;
9 |
10 | import static com.splunk.splunkjenkins.SplunkConfigUtil.verifySplunkSearchResult;
11 | import static org.junit.Assert.assertTrue;
12 |
13 | public class JdkSplunkLogHandlerTest extends BaseTest {
14 |
15 | @Before
16 | public void setUp() throws Exception {
17 | super.setUp();
18 | LoggingInitStep.registerHandler();
19 | }
20 |
21 | @Test
22 | public void publish() throws Exception {
23 | Handler[] handlers = Logger.getLogger("").getHandlers();
24 | boolean found = false;
25 | for (Handler handler : handlers) {
26 | if (handler instanceof JdkSplunkLogHandler) {
27 | found = true;
28 | break;
29 | }
30 | }
31 | assertTrue("LoggingInitStep.setupSplunkJenkins() should be called", found);
32 | String message = "test_log_" + UUID.randomUUID();
33 | Logger.getLogger("test_info_logger").info(message);
34 | Logger.getLogger("test_warning_logger").warning(message);
35 | verifySplunkSearchResult(message + " level=WARNING", 1);
36 | verifySplunkSearchResult(message + " level=INFO", 1);
37 | }
38 |
39 | }
--------------------------------------------------------------------------------
/splunk-devops/src/test/java/com/splunk/splunkjenkins/TestResultAdapterTest.java:
--------------------------------------------------------------------------------
1 | package com.splunk.splunkjenkins;
2 |
3 | import hudson.model.FreeStyleProject;
4 | import hudson.model.Run;
5 | import org.junit.Test;
6 | import org.jvnet.hudson.test.recipes.LocalData;
7 |
8 | import java.io.IOException;
9 | import java.util.UUID;
10 | import java.util.concurrent.ExecutionException;
11 |
12 | import static com.splunk.splunkjenkins.SplunkConfigUtil.verifySplunkSearchResult;
13 |
14 | public class TestResultAdapterTest extends BaseTest {
15 | @LocalData
16 | @Test
17 | public void verifyTestNG() throws ExecutionException, InterruptedException, IOException {
18 | String query = "ExampleIntegrationTest| spath | search \"testsuite.testcase{}.classname\"=ExampleIntegrationTest";
19 | FreeStyleProject project = (FreeStyleProject) j.getInstance().getItem("testng_job1");
20 | String jobName = UUID.randomUUID().toString();
21 | project.renameTo(jobName);
22 | long startTime = System.currentTimeMillis();
23 | Run run = project.scheduleBuild2(0).get();
24 | verifySplunkSearchResult(query, startTime, 1);
25 | //verify test_summary.total number
26 | String buildUrl = run.getUrl();
27 | query = "type=completed test_summary build_url=\"" + buildUrl + "\"| spath | search test_summary.total=2";
28 | verifySplunkSearchResult(query, startTime, 1);
29 | }
30 |
31 | }
32 |
--------------------------------------------------------------------------------
/Jenkinsfile:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env groovy
2 | // Parameters to run test
3 | properties([
4 | parameters([string(defaultValue: '', description: 'Splunk host', name: 'host')
5 | , string(defaultValue: '8089', description: 'Splunk management port', name: 'port')
6 | , string(defaultValue: '', description: 'Username', name: 'username')
7 | , string(defaultValue: '', description: 'Password', name: 'password')
8 | , string(defaultValue: '', description: 'Local Repo Url', name: 'repoUrl')
9 | ]),
10 | [$class: 'jenkins.model.BuildDiscarderProperty', strategy: [$class : 'LogRotator',
11 | numToKeepStr : '50',
12 | artifactNumToKeepStr: '20']]
13 | ])
14 |
15 | node {
16 | checkout scm;
17 | def mvnHome = tool name: 'default', type: 'hudson.tasks.Maven$MavenInstallation'
18 | def mvnCmd = "${mvnHome}/bin/mvn";
19 | if (params.password) {
20 | mvnCmd += " -Dhost=${params.host} -Dport=${params.port} -Dpassword=${params.password} -Dusername=${params.username}"
21 | }
22 | mvnCmd += " -Djava.net.preferIPv4Stack=true clean verify"
23 |
24 | if (params.repoUrl) {
25 | mvnCmd += " -Plocal -Drepos.url=${params.repoUrl} deploy cobertura:cobertura"
26 | }
27 | sh mvnCmd
28 | }
29 |
--------------------------------------------------------------------------------
/splunk-devops/src/test/resources/com/splunk/splunkjenkins/TestResultAdapterTest/jobs/testng_job1/config.xml:
--------------------------------------------------------------------------------
1 |
2 |
2 |
6 |
38 |
--------------------------------------------------------------------------------
/splunk-devops/src/test/resources/com/splunk/splunkjenkins/CoverageMetricTest/jobs/JaCoCo/config.xml:
--------------------------------------------------------------------------------
1 |
2 | Provide a groovy script to customize event process, 3 | will be executed when job is completed
4 | 5 |
7 | You can customize the events sent to splunk by call:
8 |
37 |
9 | //send job metadata and junit reports with page size set to 50 (each event contains max 50 test cases)
10 | splunkins.sendTestReport(50)
11 | //send coverage, each event contains max 50 class metrics
12 | splunkins.sendCoverageReport(50)
13 | //send all logs from workspace to splunk, with each file size limits to 10MB
14 | splunkins.archive("**/*.log", null, false, "10MB")
15 |
16 |
17 | The groovy script can use the variable splunkins, which provides access to the following objects and methods:
18 |
19 |
20 | Action getAction(Class type);
21 | Action getActionByClassName(String className);
22 | //send message to splunk
23 | boolean send(Object message);
24 | //Archive all configured artifacts from slave, with each file size limit to 10MB, using ant patterns defined in http://ant.apache.org/manual/Types/fileset.html
25 | archive(String includes, String excludes = null, boolean uploadFromSlave = false, String fileSizeLimit = "")
26 | //will send build parameters as metadata and with the object returned from closure to splunk
27 | sendReport(Closure closure)
28 | //a junit report with summary of passes,failures,skips and details of testcase
29 | getJunitReport()
30 | //a a list of junit report each with summary of passes,failures,skips and details of testcase
31 | //each report contains max pageSize testcases
32 | getJunitReport(int pageSize)
33 | sendTestReport(pageSize) //send Test report, with pagination support
34 | sendCoverageReport(pageSize) //send coverage report, with pagination support
35 |
36 | |
13 | |
15 |
16 | |
18 |
19 | |
21 | |
| 25 | | 26 | | 27 | | |
{@code from jenkins javadoc
19 | * (enter) --> waitingList --+--> blockedProjects
20 | * | ^
21 | * | |
22 | * | v
23 | * +--> buildables ---> pending ---> left
24 | * ^ |
25 | * | |
26 | * +---(rarely)---+
27 | *
28 | * }
29 | */
30 | @SuppressWarnings("unused")
31 | @Extension
32 | public class LoggingQueueListener extends QueueListener {
33 | private final static Cache