Fix implementation of FileWithMetadata and add tests

Author: Mike Kistler

src/main/java/com/ibm/cloud/sdk/core/service/model/FileWithMetadata.java

@@ -19,7 +19,7 @@
 import java.io.InputStream;
 
 /**
- * A file and its associated metadata
+ * A file and its associated metadata.
  */
 public class FileWithMetadata {
 
@@ -64,8 +64,7 @@ public Builder(InputStream data) {
          * @throws FileNotFoundException if the file could not be found
          */
         public Builder(File file) throws FileNotFoundException {
-            this.data = new FileInputStream(file);
-            this.filename = file.getName();
+            this.data(file);
         }
 
         /**
@@ -77,6 +76,17 @@ public FileWithMetadata build() {
             return new FileWithMetadata(this);
         }
 
+        /**
+         * Set the data.
+         *
+         * @param data the data
+         * @return the FileWithMetadata builder
+         */
+        public Builder data(InputStream data) {
+            this.data = data;
+            return this;
+        }
+
         /**
          * Set the filename.
          *
@@ -98,6 +108,18 @@ public Builder contentType(String contentType) {
             this.contentType = contentType;
             return this;
         }
+
+        /**
+         * Set the data.
+         *
+         * @param file the file to use as the source of file contents and filename
+         * @throws FileNotFoundException if the file could not be found
+         */
+        public Builder data(File file) throws FileNotFoundException {
+            this.data = new FileInputStream(file);
+            this.filename = file.getName();
+            return this;
+        }
     }
 
     private FileWithMetadata(Builder builder) {
@@ -118,7 +140,7 @@ public Builder newBuilder() {
     }
 
     /**
-     * The data / contents of the file
+     * The data / contents of the file.
      */
     public InputStream data() {
         return this.data;

src/test/java/com/ibm/cloud/sdk/core/test/model/FileWithMetadataTest.java

@@ -0,0 +1,111 @@
+/**
+ * (C) Copyright IBM Corp. 2019.
+ *
+ * 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.cloud.sdk.core.test.model;
+
+import com.ibm.cloud.sdk.core.service.model.FileWithMetadata;
+import org.testng.annotations.Test;
+
+import java.io.ByteArrayInputStream;
+import java.io.File;
+import java.io.FileNotFoundException;
+import java.io.InputStream;
+
+import static org.testng.Assert.assertEquals;
+import static org.testng.Assert.assertNotNull;
+import static org.testng.Assert.assertNull;
+
+/**
+ * A few simple tests that exercise the FileWithMetadata model.
+ */
+public class FileWithMetadataTest {
+
+    @Test
+    public void testBuilderWithOnlyRequired() {
+        byte[] fileBytes = {(byte) 0xde, (byte) 0xad, (byte) 0xbe, (byte) 0xef};
+        InputStream inputStream = new ByteArrayInputStream(fileBytes);
+        FileWithMetadata.Builder builder = new FileWithMetadata.Builder();
+        builder.data(inputStream);
+        FileWithMetadata fileWithMetadata = builder.build();
+        assertNotNull(fileWithMetadata);
+        assertNotNull(fileWithMetadata.data());
+        assertNull(fileWithMetadata.filename());
+        assertNull(fileWithMetadata.contentType());
+    }
+
+    @Test
+    public void testBuilderWithFile() throws FileNotFoundException {
+        String filename = "my-credentials.env";
+        final File myFile = new File("src/test/resources/" + filename);
+        FileWithMetadata.Builder builder = new FileWithMetadata.Builder();
+        builder.data(myFile);
+        FileWithMetadata fileWithMetadata = builder.build();
+        assertNotNull(fileWithMetadata);
+        assertNotNull(fileWithMetadata.data());
+        assertEquals(filename, fileWithMetadata.filename());
+        assertNull(fileWithMetadata.contentType());
+    }
+
+    @Test
+    public void testBuilderWithAllProps() {
+        byte[] fileBytes = {(byte) 0xca, (byte) 0xfe, (byte) 0xba, (byte) 0xbe};
+        String filename = "my-awesome-file.txt";
+        String contentType = "text/plain";
+        InputStream inputStream = new ByteArrayInputStream(fileBytes);
+        FileWithMetadata.Builder builder = new FileWithMetadata.Builder(inputStream);
+        builder.filename(filename);
+        builder.contentType(contentType);
+        FileWithMetadata fileWithMetadata = builder.build();
+        assertNotNull(fileWithMetadata);
+        assertNotNull(fileWithMetadata.data());
+        assertEquals(filename, fileWithMetadata.filename());
+        assertEquals(contentType, fileWithMetadata.contentType());
+    }
+
+    @Test
+    public void testBuilderConstructorWithFile() throws FileNotFoundException {
+        String filename = "my-credentials.env";
+        final File myFile = new File("src/test/resources/" + filename);
+        FileWithMetadata fileWithMetadata = new FileWithMetadata.Builder(myFile).build();
+        assertNotNull(fileWithMetadata);
+        assertNotNull(fileWithMetadata.data());
+        assertEquals(filename, fileWithMetadata.filename());
+        assertNull(fileWithMetadata.contentType());
+    }
+
+    @Test
+    public void testNewBuilder() {
+        byte[] fileBytes = {(byte) 0xca, (byte) 0xfe, (byte) 0xba, (byte) 0xbe};
+        String filename = "my-awesome-file.txt";
+        String contentType = "text/plain";
+        FileWithMetadata orig = new FileWithMetadata.Builder()
+                .data(new ByteArrayInputStream(fileBytes))
+                .filename("foo.txt")
+                .contentType("text/plain")
+                .build();
+        FileWithMetadata.Builder builder = orig.newBuilder();
+        builder.filename(filename);
+        builder.contentType(contentType);
+        FileWithMetadata fileWithMetadata = builder.build();
+        assertNotNull(fileWithMetadata);
+        assertNotNull(fileWithMetadata.data());
+        assertEquals(filename, fileWithMetadata.filename());
+        assertEquals(contentType, fileWithMetadata.contentType());
+    }
+
+    @Test(expectedExceptions = {IllegalArgumentException.class})
+    public void testValidation() {
+        FileWithMetadata.Builder builder = new FileWithMetadata.Builder();
+        FileWithMetadata fileWithMetadata = builder.build();
+    }
+}