View Javadoc
1   /*
2    * The MIT License (MIT)
3    *
4    * Copyright (c) 2013 - 2023, Tapio Rautonen
5    *
6    * Permission is hereby granted, free of charge, to any person obtaining a copy
7    * of this software and associated documentation files (the "Software"), to deal
8    * in the Software without restriction, including without limitation the rights
9    * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10   * copies of the Software, and to permit persons to whom the Software is
11   * furnished to do so, subject to the following conditions:
12   *
13   * The above copyright notice and this permission notice shall be included in
14   * all copies or substantial portions of the Software.
15   *
16   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19   * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21   * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22   * THE SOFTWARE.
23   */
24  package org.eluder.coveralls.maven.plugin.service;
25  
26  import java.util.Map;
27  import java.util.Properties;
28  
29  /**
30   * Service implementation for Shippable.
31   * <p>
32   * http://shippable.com/
33   */
34  public class Shippable extends AbstractServiceSetup {
35  
36      public static final String SHIPPABLE_NAME = "shippable";
37      public static final String SHIPPABLE = "SHIPPABLE";
38      public static final String SHIPPABLE_BUILD_NUMBER = "SHIPPABLE_BUILD_NUMBER";
39      public static final String SHIPPABLE_BUILD_ID = "SHIPPABLE_BUILD_ID";
40      public static final String SHIPPABLE_BRANCH = "BRANCH";
41      public static final String SHIPPABLE_COMMIT = "COMMIT";
42      public static final String SHIPPABLE_PULL_REQUEST = "PULL_REQUEST";
43  
44      public Shippable(final Map<String, String> env) {
45          super(env);
46      }
47  
48      @Override
49      public boolean isSelected() {
50          return Boolean.parseBoolean(getProperty(SHIPPABLE));
51      }
52  
53      @Override
54      public String getName() {
55          return SHIPPABLE_NAME;
56      }
57  
58      @Override
59      public String getBuildNumber() {
60          return getProperty(SHIPPABLE_BUILD_NUMBER);
61      }
62  
63      @Override
64      public String getBuildUrl() {
65          return "https://app.shippable.com/builds/" + getProperty(SHIPPABLE_BUILD_ID);
66      }
67  
68      @Override
69      public String getBranch() {
70          return getProperty(SHIPPABLE_BRANCH);
71      }
72  
73      @Override
74      public String getPullRequest() {
75          String pullRequest = getProperty(SHIPPABLE_PULL_REQUEST);
76          if ("false".equals(pullRequest)) {
77              return null;
78          }
79          return pullRequest;
80      }
81  
82      @Override
83      public Properties getEnvironment() {
84          Properties environment = new Properties();
85          addProperty(environment, "shippable_build_number", getProperty(SHIPPABLE_BUILD_NUMBER));
86          addProperty(environment, "shippable_build_id", getProperty(SHIPPABLE_BUILD_ID));
87          addProperty(environment, "shippable_build_url", getBuildUrl());
88          addProperty(environment, "branch", getProperty(SHIPPABLE_BRANCH));
89          addProperty(environment, "commit_sha", getProperty(SHIPPABLE_COMMIT));
90          return environment;
91      }
92  
93  }