refactor: rename instanceType -> dbType

rmg · rmg · commit 882441a804fe · 2015-07-26T17:09:23.000-07:00
diff --git a/pom.xml b/pom.xml
@@ -86,6 +86,26 @@
             <artifactId>unirest-java</artifactId>
             <version>1.4.6</version>
         </dependency>
+        <dependency>
+            <groupId>org.apache.httpcomponents</groupId>
+            <artifactId>httpclient</artifactId>
+            <version>4.3.6</version>
+        </dependency>
+        <dependency>
+            <groupId>org.apache.httpcomponents</groupId>
+            <artifactId>httpasyncclient</artifactId>
+            <version>4.0.2</version>
+        </dependency>
+        <dependency>
+            <groupId>org.apache.httpcomponents</groupId>
+            <artifactId>httpmime</artifactId>
+            <version>4.3.6</version>
+        </dependency>
+        <dependency>
+            <groupId>org.json</groupId>
+            <artifactId>json</artifactId>
+            <version>20140107</version>
+        </dependency>
         <dependency>
             <groupId>com.github.tomakehurst</groupId>
             <artifactId>wiremock</artifactId>
diff --git a/src/main/java/org/jenkinsci/plugins/mktmpio/Mktmpio.java b/src/main/java/org/jenkinsci/plugins/mktmpio/Mktmpio.java
@@ -21,28 +21,28 @@ public class Mktmpio extends SimpleBuildWrapper {
     public static final String DEFAULT_SERVER = "https://mktmp.io";
 
     // Job config
-    private String instanceType;
+    private String dbType;
     private boolean shutdownWithBuild = false;
 
     @DataBoundConstructor
-    public Mktmpio(String instanceType) {
-        this.instanceType = instanceType;
+    public Mktmpio(String dbType) {
+        this.dbType = dbType;
     }
 
     static void dispose(final MktmpioEnvironment env, final Launcher launcher, final TaskListener listener) throws IOException, InterruptedException {
         final String instanceID = env.id;
         MktmpioInstance instance = new MktmpioInstance(env);
         instance.destroy();
-        listener.getLogger().printf("mktmpio instance shutdown. type: %s, host: %s, port: %d\n", env.type, env.host, env.port);
+        listener.getLogger().printf("mktmpio instance shutdown. type: %s, host: %s, port: %d\n", env.dbType, env.host, env.port);
     }
 
-    public String getInstanceType() {
-        return instanceType;
+    public String getDbType() {
+        return dbType;
     }
 
     @DataBoundSetter
-    public void setInstanceType(String instanceType) {
-        this.instanceType = instanceType;
+    public void setDbType(String dbType) {
+        this.dbType = dbType;
     }
 
     public boolean isShutdownWithBuild() {
@@ -70,20 +70,20 @@ public void setUp(SimpleBuildWrapper.Context context,
         final MktmpioDescriptor config = getDescriptor();
         final String token = config.getToken();
         final String baseUrl = config.getServer();
-        final String type = getInstanceType();
+        final String dbType = getDbType();
         final MktmpioInstance instance;
         try {
             listener.getLogger().printf("Attempting to create instance (server: %s, token: %s, type: %s)",
-                    baseUrl, token.replaceAll(".", "*"), type);
-            instance = MktmpioInstance.create(baseUrl, token, type, isShutdownWithBuild());
+                    baseUrl, token.replaceAll(".", "*"), dbType);
+            instance = MktmpioInstance.create(baseUrl, token, dbType, isShutdownWithBuild());
         } catch (IOException ex) {
             listener.fatalError("mktmpio: " + ex.getMessage());
             throw new InterruptedException(ex.getMessage());
         }
         final MktmpioEnvironment env = instance.getEnv();
         final Map<String, String> envVars = env.envVars();
-        listener.hyperlink(baseUrl + "/i/" + env.id, env.type + " instance " + env.id);
-        listener.getLogger().printf("mktmpio instance created: %s\n", env.type);
+        listener.hyperlink(baseUrl + "/i/" + env.id, env.dbType + " instance " + env.id);
+        listener.getLogger().printf("mktmpio instance created: %s\n", env.dbType);
         for (Map.Entry<String, String> entry : envVars.entrySet()) {
             listener.getLogger().printf("setting %s=%s\n", entry.getKey(), entry.getValue());
         }
@@ -92,7 +92,7 @@ public void setUp(SimpleBuildWrapper.Context context,
         context.setDisposer(new MktmpioDisposer(env));
     }
 
-    public static ListBoxModel instanceTypes() {
+    public static ListBoxModel supportedDbTypes() {
         ListBoxModel items = new ListBoxModel();
         items.add("MySQL", "mysql");
         items.add("PostgreSQL-9.4", "postgres");
@@ -121,7 +121,7 @@ public boolean configure(final StaplerRequest req, final JSONObject formData) {
         }
 
         @Override
-        public BuildWrapper newInstance(final StaplerRequest req, final JSONObject formData) throws hudson.model.Descriptor.FormException {
+        public Mktmpio newInstance(final StaplerRequest req, final JSONObject formData) throws hudson.model.Descriptor.FormException {
             return req.bindJSON(Mktmpio.class, formData);
         }
 
@@ -151,8 +151,8 @@ public String getDisplayName() {
             return "Create temporary database server for build";
         }
 
-        public ListBoxModel doFillInstanceTypeItems() {
-            return instanceTypes();
+        public ListBoxModel doFillDbTypeItems() {
+            return supportedDbTypes();
         }
     }
 }
diff --git a/src/main/java/org/jenkinsci/plugins/mktmpio/MktmpioEnvironment.java b/src/main/java/org/jenkinsci/plugins/mktmpio/MktmpioEnvironment.java
@@ -14,17 +14,17 @@ public class MktmpioEnvironment extends InvisibleAction implements Serializable
     public final int port;
     public final String username;
     public final String password;
-    public final String type;
+    public final String dbType;
     public final boolean shutdownWithBuild;
 
-    public MktmpioEnvironment(final String token, final String id, final String host, final int port, final String username, final String password, final String type, final boolean shutdownWithBuild) {
+    public MktmpioEnvironment(final String token, final String id, final String host, final int port, final String username, final String password, final String dbType, final boolean shutdownWithBuild) {
         this.token = token;
         this.id = id;
         this.host = host;
         this.port = port;
         this.username = username;
         this.password = password;
-        this.type = type;
+        this.dbType = dbType;
         this.shutdownWithBuild = shutdownWithBuild;
     }
 
@@ -35,7 +35,7 @@ public Map<String, String> envVars() {
         vars.put("MKTMPIO_USERNAME", username);
         vars.put("MKTMPIO_PASSWORD", password);
         vars.put("MKTMPIO_ID", id);
-        vars.put("MKTMPIO_TYPE", type);
+        vars.put("MKTMPIO_TYPE", dbType);
         return vars;
     }
 }
diff --git a/src/main/java/org/jenkinsci/plugins/mktmpio/MktmpioInstance.java b/src/main/java/org/jenkinsci/plugins/mktmpio/MktmpioInstance.java
@@ -15,10 +15,11 @@ public MktmpioInstance(final MktmpioEnvironment env) {
         this.env = env;
     }
 
-    public static MktmpioInstance create(final String urlRoot, final String token, final String type, final boolean shutdownWithBuild) throws IOException, InterruptedException {
+    public static MktmpioInstance create(final String urlRoot, final String token, final String dbType, final boolean shutdownWithBuild) throws IOException, InterruptedException {
+        final String url = urlRoot + "/api/v1/new/" + dbType;
         HttpResponse<JsonNode> json;
         try {
-            json = Unirest.post(urlRoot + "/api/v1/new/" + type)
+            json = Unirest.post(url)
                     .header("accept", "application/json")
                     .header("X-Auth-Token", token)
                     .asJson();
@@ -31,15 +32,15 @@ public static MktmpioInstance create(final String urlRoot, final String token, f
             System.err.println("Used token: " + token);
             System.err.println("error response: " + json.getStatusText());
             System.err.println("response body: " + json.getBody().toString());
-            throw new IOException("Error creating " + type + " instance, " + message);
+            throw new IOException("Error creating " + dbType + " instance, " + message);
         }
         JSONObject res = json.getBody().getObject();
         String id = res.getString("id");
         String host = res.getString("host");
         int port = res.getInt("port");
         String username = res.optString("username", "");
         String password = res.optString("password", "");
-        final MktmpioEnvironment env = new MktmpioEnvironment(token, id, host, port, username, password, type, shutdownWithBuild);
+        final MktmpioEnvironment env = new MktmpioEnvironment(token, id, host, port, username, password, dbType, shutdownWithBuild);
         return new MktmpioInstance(env);
     }
 
diff --git a/src/main/resources/org/jenkinsci/plugins/mktmpio/Mktmpio/config.jelly b/src/main/resources/org/jenkinsci/plugins/mktmpio/Mktmpio/config.jelly
@@ -1,6 +1,6 @@
 <?jelly escape-by-default='true'?>
 <j:jelly xmlns:j="jelly:core" xmlns:st="jelly:stapler" xmlns:d="jelly:define" xmlns:l="/lib/layout" xmlns:t="/lib/hudson" xmlns:f="/lib/form">
-    <f:entry field="instanceType" title="Database Type">
+    <f:entry field="dbType" title="Database Type">
         <f:select />
     </f:entry>
 </j:jelly>
diff --git a/src/main/resources/org/jenkinsci/plugins/mktmpio/Mktmpio/help-dbType.html b/src/main/resources/org/jenkinsci/plugins/mktmpio/Mktmpio/help-dbType.html
diff --git a/src/test/java/org/jenkinsci/plugins/mktmpio/MktmpioInstanceTest.java b/src/test/java/org/jenkinsci/plugins/mktmpio/MktmpioInstanceTest.java
@@ -26,7 +26,7 @@ public void succeedsWithGoodCredentials() throws Exception {
         prepareFakeInstance("totally-legit-token", "redis");
         MktmpioInstance redis = MktmpioInstance.create(mockedServer(), "totally-legit-token", "redis", true);
         assertThat("result is not null", redis != null);
-        assertThat(redis.getEnv().type, is("redis"));
+        assertThat(redis.getEnv().dbType, is("redis"));
         redis.destroy();
     }
 }
diff --git a/src/test/java/org/jenkinsci/plugins/mktmpio/MktmpioWorkflowTest.java b/src/test/java/org/jenkinsci/plugins/mktmpio/MktmpioWorkflowTest.java
@@ -58,7 +58,7 @@ public void evaluate() throws Throwable {
 
                 workflowJob.setDefinition(new CpsFlowDefinition(""
                         + "node {\n"
-                        + "  wrap([$class: 'Mktmpio', instanceType: 'redis']) {\n"
+                        + "  wrap([$class: 'Mktmpio', dbType: 'redis']) {\n"
                         + "    semaphore 'shouldAllowWorkflowRestarts'\n"
                         + "    sh 'echo REDIS_HOST=$MKTMPIO_HOST'\n"
                         + "  }\n"
@@ -104,7 +104,7 @@ public void evaluate() throws Throwable {
 
                 workflowJob.setDefinition(new CpsFlowDefinition(""
                         + "node {\n"
-                        + "  wrap([$class: 'Mktmpio', instanceType: 'redis']) {\n"
+                        + "  wrap([$class: 'Mktmpio', dbType: 'redis']) {\n"
                         + "    sh 'echo REDIS_HOST=$MKTMPIO_HOST'\n"
                         + "  }\n"
                         + "}", true));

Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,7 @@ public void succeedsWithGoodCredentials() throws Exception {`
`26`	`26`	`prepareFakeInstance("totally-legit-token", "redis");`
`27`	`27`	`MktmpioInstance redis = MktmpioInstance.create(mockedServer(), "totally-legit-token", "redis", true);`
`28`	`28`	`assertThat("result is not null", redis != null);`
`29`		`- assertThat(redis.getEnv().type, is("redis"));`
	`29`	`+ assertThat(redis.getEnv().dbType, is("redis"));`
`30`	`30`	`redis.destroy();`
`31`	`31`	`}`
`32`	`32`	`}`