Merge pull request #12 from browserstack/ga_tracking

Bump Dependencies and change default environment variables

Author: tr4n2uil

browserstack-teamcity-agent/src/main/java/com/browserstack/automate/ci/teamcity/BrowserStackLocalAgent.java

@@ -64,9 +64,9 @@ public void beforeRunnerStart(@NotNull BuildRunnerContext runner) {
                 config.get(BrowserStackParameters.BROWSERSTACK_LOCAL_OPTIONS),
                 buildLogger);
 
-        if (config.containsKey(EnvVars.BROWSERSTACK_ACCESSKEY)) {
+        if (config.containsKey(EnvVars.BROWSERSTACK_ACCESS_KEY)) {
             Map<String, String> localOptions = new HashMap<String, String>();
-            localOptions.put("key", config.get(EnvVars.BROWSERSTACK_ACCESSKEY));
+            localOptions.put("key", config.get(EnvVars.BROWSERSTACK_ACCESS_KEY));
             buildLogger.message("Starting BrowserStack Local");
 
             try {
@@ -88,7 +88,7 @@ public void beforeRunnerStart(@NotNull BuildRunnerContext runner) {
                 runner.getBuild().stopBuild(errMessage);
             }
         } else {
-            buildLogger.message(EnvVars.BROWSERSTACK_ACCESSKEY + " not configured.");
+            buildLogger.message(EnvVars.BROWSERSTACK_ACCESS_KEY + " not configured.");
         }
     }
 
@@ -141,17 +141,17 @@ private void loadBuildFeature(final AgentRunningBuild build) {
      * @param config
      */
     private void exportEnvVars(final BuildRunnerContext runner, final Map<String, String> config) {
-        if (!config.containsKey(EnvVars.BROWSERSTACK_USER) || !config.containsKey(EnvVars.BROWSERSTACK_ACCESSKEY)) {
+        if (!config.containsKey(EnvVars.BROWSERSTACK_USERNAME) || !config.containsKey(EnvVars.BROWSERSTACK_ACCESS_KEY)) {
             return;
         }
 
-        runner.addEnvironmentVariable(EnvVars.BROWSERSTACK_USER, config.get(EnvVars.BROWSERSTACK_USER));
-        runner.addEnvironmentVariable(EnvVars.BROWSERSTACK_ACCESSKEY, config.get(EnvVars.BROWSERSTACK_ACCESSKEY));
+        runner.addEnvironmentVariable(EnvVars.BROWSERSTACK_USERNAME, config.get(EnvVars.BROWSERSTACK_USERNAME));
+        runner.addEnvironmentVariable(EnvVars.BROWSERSTACK_ACCESS_KEY, config.get(EnvVars.BROWSERSTACK_ACCESS_KEY));
         runner.addEnvironmentVariable(EnvVars.BROWSERSTACK_LOCAL, config.get(EnvVars.BROWSERSTACK_LOCAL));
 
         BuildProgressLogger buildLogger = runner.getBuild().getBuildLogger();
-        buildLogger.message(EnvVars.BROWSERSTACK_USER + "=" + config.get(EnvVars.BROWSERSTACK_USER));
-        buildLogger.message(EnvVars.BROWSERSTACK_ACCESSKEY + "=" + config.get(EnvVars.BROWSERSTACK_ACCESSKEY));
+        buildLogger.message(EnvVars.BROWSERSTACK_USERNAME + "=" + config.get(EnvVars.BROWSERSTACK_USERNAME));
+        buildLogger.message(EnvVars.BROWSERSTACK_ACCESS_KEY + "=" + config.get(EnvVars.BROWSERSTACK_ACCESS_KEY));
         buildLogger.message(EnvVars.BROWSERSTACK_LOCAL + "=" + config.get(EnvVars.BROWSERSTACK_LOCAL));
 
         if (localIdentifier != null) {

browserstack-teamcity-common/pom.xml

@@ -14,13 +14,13 @@
         <dependency>
             <groupId>com.browserstack</groupId>
             <artifactId>automate-client-java</artifactId>
-            <version>0.2-SNAPSHOT</version>
+            <version>0.2</version>
         </dependency>
 
         <dependency>
             <groupId>com.browserstack</groupId>
             <artifactId>browserstack-local-java</artifactId>
-            <version>0.3.0</version>
+            <version>1.0.0</version>
         </dependency>
 
         <dependency>

browserstack-teamcity-common/src/main/java/com/browserstack/automate/ci/common/analytics/Analytics.java

@@ -22,6 +22,8 @@ public class Analytics {
     protected static final String DEFAULT_CLIENT_ID = "unknown-client";
     private static final String PLUGIN_PROPERTIES_FILE = "plugin.properties";
     private static final String GOOGLE_PROPERTIES_KEY = "google.analytics.tracking.id";
+    private static final String APP_NAME_PREFIX = "teamcity-";
+    private static final String APP_VERSION_PREFIX = "teamcity-plugin-";
 
     private String clientId;
 
@@ -53,7 +55,7 @@ private GoogleAnalytics buildGoogleAnalyticsClient() {
         Properties pluginProps = new Properties();
         InputStream inputStream = null;
         try {
-            inputStream = new FileInputStream(PLUGIN_PROPERTIES_FILE);
+            inputStream = getClass().getClassLoader().getResourceAsStream(PLUGIN_PROPERTIES_FILE);
             pluginProps.load(inputStream);
 
             String trackingId = pluginProps.getProperty(GOOGLE_PROPERTIES_KEY);
@@ -91,9 +93,9 @@ protected TimingHit newTimingHit(String category, String variable, int time) {
 
     protected void attachGlobalProperties(GoogleAnalyticsRequest gaRequest) {
         gaRequest.clientId((clientId != null) ? clientId : getClientId());
-        gaRequest.applicationName(dataProvider.getApplicationVersion());
+        gaRequest.applicationName(APP_NAME_PREFIX + dataProvider.getApplicationVersion());
         gaRequest.applicationId(dataProvider.getPluginName());
-        gaRequest.applicationVersion(dataProvider.getPluginVersion());
+        gaRequest.applicationVersion(APP_VERSION_PREFIX + dataProvider.getPluginVersion());
     }
 
     public void trackInstall() {

browserstack-teamcity-common/src/main/java/com/browserstack/automate/ci/teamcity/BrowserStackParameters.java

@@ -5,8 +5,8 @@
 public class BrowserStackParameters {
 
     public interface EnvVars {
-        String BROWSERSTACK_USER = "BROWSERSTACK_USER";
-        String BROWSERSTACK_ACCESSKEY = "BROWSERSTACK_ACCESSKEY";
+        String BROWSERSTACK_USERNAME = "BROWSERSTACK_USERNAME";
+        String BROWSERSTACK_ACCESS_KEY = "BROWSERSTACK_ACCESS_KEY";
         String BROWSERSTACK_LOCAL = "BROWSERSTACK_LOCAL";
         String BROWSERSTACK_LOCAL_IDENTIFIER = "BROWSERSTACK_LOCAL_IDENTIFIER";
         String BROWSERSTACK_BUILD = "BROWSERSTACK_BUILD";

browserstack-teamcity-server/pom.xml

@@ -20,7 +20,7 @@
     <dependency>
       <groupId>com.browserstack</groupId>
       <artifactId>automate-client-java</artifactId>
-      <version>0.2-SNAPSHOT</version>
+      <version>0.2</version>
     </dependency>
 
     <dependency>

browserstack-teamcity-server/src/main/java/com/browserstack/automate/ci/teamcity/config/AutomateBuildFeature.java

@@ -71,8 +71,8 @@ public boolean isMultipleFeaturesPerBuildTypeAllowed() {
     @NotNull
     @Override
     public String describeParameters(@NotNull Map<String, String> params) {
-        boolean hasCredentials = params.containsKey(EnvVars.BROWSERSTACK_USER) &&
-                params.containsKey(EnvVars.BROWSERSTACK_ACCESSKEY);
+        boolean hasCredentials = params.containsKey(EnvVars.BROWSERSTACK_USERNAME) &&
+                params.containsKey(EnvVars.BROWSERSTACK_ACCESS_KEY);
         if (!hasCredentials) {
             return "Requires configuration of credentials.";
         }

browserstack-teamcity-server/src/main/java/com/browserstack/automate/ci/teamcity/ui/AutomateResultsTab.java

@@ -192,8 +192,8 @@ public static AutomateClient newAutomateClient(final SBuild build) {
         SBuildFeatureDescriptor featureDescriptor = AutomateBuildFeature.findFeatureDescriptor(build);
         if (featureDescriptor != null) {
             Map<String, String> params = featureDescriptor.getParameters();
-            String username = params.get(BrowserStackParameters.EnvVars.BROWSERSTACK_USER);
-            String accessKey = params.get(BrowserStackParameters.EnvVars.BROWSERSTACK_ACCESSKEY);
+            String username = params.get(BrowserStackParameters.EnvVars.BROWSERSTACK_USERNAME);
+            String accessKey = params.get(BrowserStackParameters.EnvVars.BROWSERSTACK_ACCESS_KEY);
 
             if (StringUtils.isNotBlank(username) && StringUtils.isNotBlank(accessKey)) {
                 return new AutomateClient(username, accessKey);

browserstack-teamcity-server/src/main/resources/buildServerResources/automateSettings.jsp

@@ -7,26 +7,26 @@
 <%@ page import="com.browserstack.automate.ci.teamcity.BrowserStackParameters" %>
 <jsp:useBean id="propertiesBean" scope="request" type="jetbrains.buildServer.controllers.BasePropertiesBean"/>
 
-<tr id="<%= BrowserStackParameters.EnvVars.BROWSERSTACK_USER %>.container">
-    <th><label for="<%= BrowserStackParameters.EnvVars.BROWSERSTACK_USER %>">Username:</label></th>
+<tr id="<%= BrowserStackParameters.EnvVars.BROWSERSTACK_USERNAME %>.container">
+    <th><label for="<%= BrowserStackParameters.EnvVars.BROWSERSTACK_USERNAME %>">Username:</label></th>
     <td>
-        <props:textProperty name="<%= BrowserStackParameters.EnvVars.BROWSERSTACK_USER %>"/>
+        <props:textProperty name="<%= BrowserStackParameters.EnvVars.BROWSERSTACK_USERNAME %>"/>
 
         <span class="smallNote">
             Set your BrowserStack username. You can get it from <a href="https://www.browserstack.com/accounts/settings" target="_blank">here</a>.
         </span>
-        <span class="error" id="error_<%= BrowserStackParameters.EnvVars.BROWSERSTACK_USER %>"/>
+        <span class="error" id="error_<%= BrowserStackParameters.EnvVars.BROWSERSTACK_USERNAME %>"/>
     </td>
 </tr>
-<tr id="<%= BrowserStackParameters.EnvVars.BROWSERSTACK_ACCESSKEY %>.container">
-    <th><label for="<%= BrowserStackParameters.EnvVars.BROWSERSTACK_ACCESSKEY %>">Access Key:</label></th>
+<tr id="<%= BrowserStackParameters.EnvVars.BROWSERSTACK_ACCESS_KEY %>.container">
+    <th><label for="<%= BrowserStackParameters.EnvVars.BROWSERSTACK_ACCESS_KEY %>">Access Key:</label></th>
     <td>
-        <props:textProperty name="<%= BrowserStackParameters.EnvVars.BROWSERSTACK_ACCESSKEY %>"/>
+        <props:textProperty name="<%= BrowserStackParameters.EnvVars.BROWSERSTACK_ACCESS_KEY %>"/>
 
         <span class="smallNote">
             Set your BrowserStack access key. You can get it from <a href="https://www.browserstack.com/accounts/settings" target="_blank">here</a>.
         </span>
-        <span class="error" id="error_<%= BrowserStackParameters.EnvVars.BROWSERSTACK_ACCESSKEY %>"/>
+        <span class="error" id="error_<%= BrowserStackParameters.EnvVars.BROWSERSTACK_ACCESS_KEY %>"/>
     </td>
 </tr>
 <tr id="<%= BrowserStackParameters.EnvVars.BROWSERSTACK_LOCAL %>.container">

browserstack-teamcity-server/src/test/java/com/browserstack/automate/ci/teamcity/AutomateBuildFeatureTest.java

@@ -89,8 +89,8 @@ public void testDescriptionForLocalFalse() throws Exception {
     @NotNull
     private Map<String, String> createParams() {
         Map<String, String> paramMap = new HashMap<String, String>();
-        paramMap.put(BrowserStackParameters.EnvVars.BROWSERSTACK_USER, "RandomUser");
-        paramMap.put(BrowserStackParameters.EnvVars.BROWSERSTACK_ACCESSKEY, "RandomAccess456Key");
+        paramMap.put(BrowserStackParameters.EnvVars.BROWSERSTACK_USERNAME, "RandomUser");
+        paramMap.put(BrowserStackParameters.EnvVars.BROWSERSTACK_ACCESS_KEY, "RandomAccess456Key");
         return paramMap;
     }
 

build/pom.xml

@@ -13,7 +13,7 @@
 
     <properties>
         <maven.build.timestamp.format>yyyyMMddHHmmss</maven.build.timestamp.format>
-        <teamcity.browserstack-teamcity.plugin.version>${project.version}-RC1</teamcity.browserstack-teamcity.plugin.version>
+        <teamcity.browserstack-teamcity.plugin.version>${project.version}</teamcity.browserstack-teamcity.plugin.version>
         <teamcity.browserstack-teamcity.plugin.vendorName>BrowserStack</teamcity.browserstack-teamcity.plugin.vendorName>
         <teamcity.browserstack-teamcity.plugin.vendorUrl>https://www.browserstack.com</teamcity.browserstack-teamcity.plugin.vendorUrl>
     </properties>