Merge pull request #2 from watson-developer-cloud/mdk/build-and-test-improvements

germanattanasio · web-flow · commit a688249cf496 · 2018-01-17T14:51:08.000-05:00
Build and test improvements
diff --git a/.travis.yml b/.travis.yml
@@ -0,0 +1,14 @@
+language: java
+jdk:
+  - oraclejdk8
+
+script:
+  - ./gradlew check
+  - ./gradlew install -x check
+  - ./gradlew codeCoverageReport --continue
+
+after_success:
+  - bash <(curl -s https://codecov.io/bash)
+
+notifications:
+  email: true
diff --git a/build.gradle b/build.gradle
@@ -22,7 +22,7 @@ buildscript {
 }
 
 plugins {
-    id 'net.researchgate.release' version '2.4.0'
+    id 'net.researchgate.release' version '2.6.0'
 }
 
 apply plugin: 'java'
@@ -33,8 +33,6 @@ apply plugin: 'idea'
 apply plugin: 'propdeps'
 apply plugin: 'propdeps-maven'
 
-import org.apache.tools.ant.filters.*
-
 archivesBaseName = 'spring-boot-starter'
 
 description = 'Spring Boot Starter for the IBM Watson Services'
@@ -45,10 +43,6 @@ version = new File(rootDir, 'VERSION').text.trim()
 // If the version says "snapshot" anywhere assume it is not a release
 ext.isReleaseVersion = !version.toUpperCase(Locale.ENGLISH).contains("SNAPSHOT")
 
-javadoc {
-    source = 'src/main/java'
-}
-
 checkstyle {
     configFile = rootProject.file('checkstyle.xml')
     ignoreFailures = false
@@ -62,10 +56,6 @@ checkstyleTest {
     ignoreFailures = false
 }
 
-task docs(type: Javadoc) {
-    destinationDir = file("$buildDir/docs/all")
-}
-
 task copyJars(type: Copy) {
     from subprojects.collect { it.tasks.withType(Jar) }
     into "$buildDir/allJars"
@@ -101,6 +91,7 @@ dependencies {
 
     // testing
     testCompile group: 'junit', name: 'junit', version: '4.12'
+    testCompile 'com.github.stefanbirkner:system-rules:1.16.0'
     testCompile group: 'org.springframework.boot', name: 'spring-boot-starter-test', version: springBootVersion
 }
 
@@ -113,49 +104,20 @@ test {
     }
 }
 
-afterEvaluate {
-    if (plugins.hasPlugin(JavaPlugin)) {
-        rootProject.tasks.docs {
-            source += files(sourceSets.main.allJava)
-            classpath += files(sourceSets*.compileClasspath)
-        }
-    }
-}
-
 apply plugin: 'jacoco'
 
-task codeCoverageReport(type: JacocoReport) {
-    // Gather execution data from all sub projects
-    // (change this if you e.g. want to calculate unit test/integration test coverage separately)
+task codeCoverageReport(type: JacocoReport, dependsOn: test) {
     executionData fileTree(project.rootDir.absolutePath).include("**/build/jacoco/*.exec")
-
-    // Add all relevant source sets from the sub projects
-    subprojects.each {
-        sourceSets it.sourceSets.main
-    }
+    sourceDirectories = files(sourceSets.main.allSource.srcDirs)
+    classDirectories = files(sourceSets.main.output)
 
     reports {
-        xml.enabled true
-        xml.destination file("${buildDir}/reports/jacoco/report.xml")
-        html.enabled true
-        html.destination file("${buildDir}/reports/jacoco")
         csv.enabled false
+        html.destination file("${buildDir}/reports/jacoco")
+        xml.destination file("${buildDir}/reports/jacoco/report.xml")
     }
 }
 
-// always run the tests before generating the report
-codeCoverageReport.dependsOn {
-    subprojects*.test
-    testReport
-}
-
-task testReport(type: TestReport) {
-    destinationDir = file("$buildDir/reports/allTests")
-
-    // Include the results from the `test` task in all subprojects
-    reportOn subprojects*.test
-}
-
 release {
     tagTemplate = 'watson-spring-boot-$version'
 }
diff --git a/src/test/java/com/ibm/watson/developer_cloud/spring/boot/test/ConversationAutoConfigTest.java b/src/test/java/com/ibm/watson/developer_cloud/spring/boot/test/ConversationAutoConfigTest.java
@@ -61,11 +61,11 @@ public void conversationBeanConfig() {
     try {
       Field apiKeyField = WatsonService.class.getDeclaredField("apiKey");
       apiKeyField.setAccessible(true);
-      assertEquals(Credentials.basic(username, password), (String) apiKeyField.get(conversation));
+      assertEquals(Credentials.basic(username, password), apiKeyField.get(conversation));
 
       Field versionField = Conversation.class.getDeclaredField("versionDate");
       versionField.setAccessible(true);
-      assertEquals(versionDate, (String) versionField.get(conversation));
+      assertEquals(versionDate, versionField.get(conversation));
     } catch (NoSuchFieldException | IllegalAccessException ex) {
       // This shouldn't happen
       assert false;
diff --git a/src/test/java/com/ibm/watson/developer_cloud/spring/boot/test/DiscoveryAutoConfigTest.java b/src/test/java/com/ibm/watson/developer_cloud/spring/boot/test/DiscoveryAutoConfigTest.java
@@ -61,11 +61,11 @@ public void discoveryBeanConfig() {
     try {
       Field apiKeyField = WatsonService.class.getDeclaredField("apiKey");
       apiKeyField.setAccessible(true);
-      assertEquals(Credentials.basic(username, password), (String) apiKeyField.get(discovery));
+      assertEquals(Credentials.basic(username, password), apiKeyField.get(discovery));
 
       Field versionField = Discovery.class.getDeclaredField("versionDate");
       versionField.setAccessible(true);
-      assertEquals(versionDate, (String) versionField.get(discovery));
+      assertEquals(versionDate, versionField.get(discovery));
     } catch (NoSuchFieldException | IllegalAccessException ex) {
       // This shouldn't happen
       assert false;
diff --git a/src/test/java/com/ibm/watson/developer_cloud/spring/boot/test/LanguageTranslatorAutoConfigTest.java b/src/test/java/com/ibm/watson/developer_cloud/spring/boot/test/LanguageTranslatorAutoConfigTest.java
@@ -59,7 +59,7 @@ public void languageTranslatorBeanConfig() {
     try {
       Field apiKeyField = WatsonService.class.getDeclaredField("apiKey");
       apiKeyField.setAccessible(true);
-      assertEquals(Credentials.basic(username, password), (String) apiKeyField.get(languageTranslator));
+      assertEquals(Credentials.basic(username, password), apiKeyField.get(languageTranslator));
     } catch (NoSuchFieldException | IllegalAccessException ex) {
       // This shouldn't happen
       assert false;
diff --git a/src/test/java/com/ibm/watson/developer_cloud/spring/boot/test/NaturalLanguageClassifierAutoConfigTest.java b/src/test/java/com/ibm/watson/developer_cloud/spring/boot/test/NaturalLanguageClassifierAutoConfigTest.java
@@ -60,7 +60,7 @@ public void naturalLanguageClassifierBeanConfig() {
     try {
       Field apiKeyField = WatsonService.class.getDeclaredField("apiKey");
       apiKeyField.setAccessible(true);
-      assertEquals(Credentials.basic(username, password), (String) apiKeyField.get(naturalLanguageClassifier));
+      assertEquals(Credentials.basic(username, password), apiKeyField.get(naturalLanguageClassifier));
     } catch (NoSuchFieldException | IllegalAccessException ex) {
       // This shouldn't happen
       assert false;
diff --git a/src/test/java/com/ibm/watson/developer_cloud/spring/boot/test/NaturalLanguageUnderstandingAutoConfigTest.java b/src/test/java/com/ibm/watson/developer_cloud/spring/boot/test/NaturalLanguageUnderstandingAutoConfigTest.java
@@ -62,11 +62,11 @@ public void naturalLanguageUnderstandingBeanConfig() {
     try {
       Field apiKeyField = WatsonService.class.getDeclaredField("apiKey");
       apiKeyField.setAccessible(true);
-      assertEquals(Credentials.basic(username, password), (String) apiKeyField.get(naturalLanguageUnderstanding));
+      assertEquals(Credentials.basic(username, password), apiKeyField.get(naturalLanguageUnderstanding));
 
       Field versionField = NaturalLanguageUnderstanding.class.getDeclaredField("versionDate");
       versionField.setAccessible(true);
-      assertEquals(versionDate, (String) versionField.get(naturalLanguageUnderstanding));
+      assertEquals(versionDate, versionField.get(naturalLanguageUnderstanding));
     } catch (NoSuchFieldException | IllegalAccessException ex) {
       // This shouldn't happen
       assert false;
diff --git a/src/test/java/com/ibm/watson/developer_cloud/spring/boot/test/PersonalityInsightsAutoConfigTest.java b/src/test/java/com/ibm/watson/developer_cloud/spring/boot/test/PersonalityInsightsAutoConfigTest.java
@@ -61,11 +61,11 @@ public void personalityInsightsBeanConfig() {
     try {
       Field apiKeyField = WatsonService.class.getDeclaredField("apiKey");
       apiKeyField.setAccessible(true);
-      assertEquals(Credentials.basic(username, password), (String) apiKeyField.get(personalityInsights));
+      assertEquals(Credentials.basic(username, password), apiKeyField.get(personalityInsights));
 
       Field versionField = PersonalityInsights.class.getDeclaredField("versionDate");
       versionField.setAccessible(true);
-      assertEquals(versionDate, (String) versionField.get(personalityInsights));
+      assertEquals(versionDate, versionField.get(personalityInsights));
     } catch (NoSuchFieldException | IllegalAccessException ex) {
       // This shouldn't happen
       assert false;
diff --git a/src/test/java/com/ibm/watson/developer_cloud/spring/boot/test/SpeechToTextAutoConfigTest.java b/src/test/java/com/ibm/watson/developer_cloud/spring/boot/test/SpeechToTextAutoConfigTest.java
@@ -59,7 +59,7 @@ public void speechToTextBeanConfig() {
     try {
       Field apiKeyField = WatsonService.class.getDeclaredField("apiKey");
       apiKeyField.setAccessible(true);
-      assertEquals(Credentials.basic(username, password), (String) apiKeyField.get(speechToText));
+      assertEquals(Credentials.basic(username, password), apiKeyField.get(speechToText));
     } catch (NoSuchFieldException | IllegalAccessException ex) {
       // This shouldn't happen
       assert false;
diff --git a/src/test/java/com/ibm/watson/developer_cloud/spring/boot/test/TextToSpeechAutoConfigTest.java b/src/test/java/com/ibm/watson/developer_cloud/spring/boot/test/TextToSpeechAutoConfigTest.java
@@ -59,7 +59,7 @@ public void textToSpeechBeanConfig() {
     try {
       Field apiKeyField = WatsonService.class.getDeclaredField("apiKey");
       apiKeyField.setAccessible(true);
-      assertEquals(Credentials.basic(username, password), (String) apiKeyField.get(textToSpeech));
+      assertEquals(Credentials.basic(username, password), apiKeyField.get(textToSpeech));
     } catch (NoSuchFieldException | IllegalAccessException ex) {
       // This shouldn't happen
       assert false;
diff --git a/src/test/java/com/ibm/watson/developer_cloud/spring/boot/test/ToneAnalyzerAutoConfigTest.java b/src/test/java/com/ibm/watson/developer_cloud/spring/boot/test/ToneAnalyzerAutoConfigTest.java
@@ -61,11 +61,11 @@ public void toneAnalyzerBeanConfig() {
     try {
       Field apiKeyField = WatsonService.class.getDeclaredField("apiKey");
       apiKeyField.setAccessible(true);
-      assertEquals(Credentials.basic(username, password), (String) apiKeyField.get(toneAnalyzer));
+      assertEquals(Credentials.basic(username, password), apiKeyField.get(toneAnalyzer));
 
       Field versionField = ToneAnalyzer.class.getDeclaredField("versionDate");
       versionField.setAccessible(true);
-      assertEquals(versionDate, (String) versionField.get(toneAnalyzer));
+      assertEquals(versionDate, versionField.get(toneAnalyzer));
     } catch (NoSuchFieldException | IllegalAccessException ex) {
       // This shouldn't happen
       assert false;
diff --git a/src/test/java/com/ibm/watson/developer_cloud/spring/boot/test/VisualRecognitionAutoConfigTest.java b/src/test/java/com/ibm/watson/developer_cloud/spring/boot/test/VisualRecognitionAutoConfigTest.java
@@ -58,11 +58,11 @@ public void visualRecognitionBeanConfig() {
     try {
       Field apiKeyField = WatsonService.class.getDeclaredField("apiKey");
       apiKeyField.setAccessible(true);
-      assertEquals(apiKey, (String) apiKeyField.get(visualRecognition));
+      assertEquals(apiKey, apiKeyField.get(visualRecognition));
 
       Field versionField = VisualRecognition.class.getDeclaredField("versionDate");
       versionField.setAccessible(true);
-      assertEquals(versionDate, (String) versionField.get(visualRecognition));
+      assertEquals(versionDate, versionField.get(visualRecognition));
     } catch (NoSuchFieldException | IllegalAccessException ex) {
       // This shouldn't happen
       assert false;
diff --git a/src/test/java/com/ibm/watson/developer_cloud/spring/boot/test/WatsonAutoConfigTest.java b/src/test/java/com/ibm/watson/developer_cloud/spring/boot/test/WatsonAutoConfigTest.java
@@ -0,0 +1,82 @@
+/*
+ * Copyright © 2017 IBM Corp. All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under the
+ * License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
+ * either express or implied. See the License for the specific language governing permissions
+ * and limitations under the License.
+ */
+
+package com.ibm.watson.developer_cloud.spring.boot.test;
+
+import com.ibm.watson.developer_cloud.language_translator.v2.LanguageTranslator;
+import com.ibm.watson.developer_cloud.service.WatsonService;
+import com.ibm.watson.developer_cloud.spring.boot.WatsonAutoConfiguration;
+import okhttp3.Credentials;
+import org.junit.ClassRule;
+import org.junit.Test;
+import org.junit.contrib.java.lang.system.EnvironmentVariables;
+import org.junit.runner.RunWith;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.context.ApplicationContext;
+import org.springframework.test.context.ContextConfiguration;
+import org.springframework.test.context.TestPropertySource;
+import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
+import org.springframework.test.context.support.AnnotationConfigContextLoader;
+
+import java.lang.reflect.Field;
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertNotNull;
+
+@RunWith(SpringJUnit4ClassRunner.class)
+@ContextConfiguration(classes = {WatsonAutoConfiguration.class}, loader = AnnotationConfigContextLoader.class)
+@TestPropertySource(properties = {"watson.language_translator.enabled=true"})
+public class WatsonAutoConfigTest {
+
+    private static final String url = "http://watson.com/language_translator";
+    private static final String username = "sam";
+    private static final String password = "secret";
+
+    @ClassRule
+    public static final EnvironmentVariables environmentVariables = new EnvironmentVariables();
+
+    static {
+        String vcapServices = "{\"language_translator\":[{"
+                    + "\"credentials\": {"
+                        + "\"url\":\"" + url + "\","
+                        + "\"username\":\"" + username + "\","
+                        + "\"password\":\"" + password + "\""
+                    + "},"
+                    + "\"plan\": \"free\""
+                + "}]}";
+        environmentVariables.set("VCAP_SERVICES", vcapServices);
+    }
+
+    @Autowired
+    private ApplicationContext applicationContext;
+
+    @Test
+    public void watsonBeanConfigFromEnvironment() {
+        LanguageTranslator languageTranslator = (LanguageTranslator) applicationContext.getBean("languageTranslator");
+
+        assertNotNull(languageTranslator);
+        // URL is not set from VCAP_SERVICES
+        //assertEquals(url, languageTranslator.getEndPoint());
+
+        // Verify the credentials -- which are stored in a private member variable
+        try {
+            Field apiKeyField = WatsonService.class.getDeclaredField("apiKey");
+            apiKeyField.setAccessible(true);
+            assertEquals(Credentials.basic(username, password), apiKeyField.get(languageTranslator));
+        } catch (NoSuchFieldException | IllegalAccessException ex) {
+            // This shouldn't happen
+            assert false;
+        }
+    }
+}
