Use Streams instead of java.io.File

Author: gesellix

api-client/src/main/kotlin/de/gesellix/docker/remote/api/client/ContainerApi.kt

@@ -41,6 +41,7 @@ import kotlinx.coroutines.flow.collect
 import kotlinx.coroutines.launch
 import kotlinx.coroutines.runBlocking
 import kotlinx.coroutines.withTimeout
+import okio.Source
 import okio.source
 import java.io.InputStream
 import java.net.HttpURLConnection.HTTP_NOT_FOUND
@@ -64,21 +65,21 @@ class ContainerApi(dockerClientConfig: DockerClientConfig = defaultClientConfig,
    * Get a tar archive of a resource in the filesystem of container id.
    * @param id ID or name of the container
    * @param path Resource in the container’s filesystem to archive.
-   * @return void
+   * @return InputStream
    * @throws UnsupportedOperationException If the API returns an informational or redirection response
    * @throws ClientException If the API returns a client error response
    * @throws ServerException If the API returns a server error response
    */
   @Throws(UnsupportedOperationException::class, ClientException::class, ServerException::class)
-  fun containerArchive(id: String, path: String): java.io.File {
+  fun containerArchive(id: String, path: String): InputStream {
     val localVariableConfig = containerArchiveRequestConfig(id = id, path = path)
 
-    val localVarResponse = request<java.io.File?>(
+    val localVarResponse = request<InputStream?>(
       localVariableConfig
     )
 
     return when (localVarResponse.responseType) {
-      ResponseType.Success -> (localVarResponse as Success<*>).data as java.io.File
+      ResponseType.Success -> (localVarResponse as Success<*>).data as InputStream
       ResponseType.Informational -> throw UnsupportedOperationException("Client does not support Informational responses.")
       ResponseType.Redirection -> throw UnsupportedOperationException("Client does not support Redirection responses.")
       ResponseType.ClientError -> {
@@ -584,15 +585,15 @@ class ContainerApi(dockerClientConfig: DockerClientConfig = defaultClientConfig,
    * @throws ServerException If the API returns a server error response
    */
   @Throws(UnsupportedOperationException::class, ClientException::class, ServerException::class)
-  fun containerExport(id: String): java.io.File {
+  fun containerExport(id: String): InputStream {
     val localVariableConfig = containerExportRequestConfig(id = id)
 
-    val localVarResponse = request<java.io.File>(
+    val localVarResponse = request<InputStream>(
       localVariableConfig
     )
 
     return when (localVarResponse.responseType) {
-      ResponseType.Success -> (localVarResponse as Success<*>).data as java.io.File
+      ResponseType.Success -> (localVarResponse as Success<*>).data as InputStream
       ResponseType.Informational -> throw UnsupportedOperationException("Client does not support Informational responses.")
       ResponseType.Redirection -> throw UnsupportedOperationException("Client does not support Redirection responses.")
       ResponseType.ClientError -> {
@@ -829,7 +830,7 @@ class ContainerApi(dockerClientConfig: DockerClientConfig = defaultClientConfig,
    * @param until Only return logs before this time, as a UNIX timestamp (optional, default to 0)
    * @param timestamps Add timestamps to every log line (optional, default to false)
    * @param tail Only return this number of log lines from the end of the logs. Specify as an integer or &#x60;all&#x60; to output all log lines.  (optional, default to "all")
-   * @return java.io.File
+   * @return void
    * @throws UnsupportedOperationException If the API returns an informational or redirection response
    * @throws ClientException If the API returns a client error response
    * @throws ServerException If the API returns a server error response
@@ -1699,7 +1700,7 @@ class ContainerApi(dockerClientConfig: DockerClientConfig = defaultClientConfig,
    * @return RequestConfig
    */
   fun putContainerArchiveRequestConfig(id: String, path: String, inputStream: InputStream, noOverwriteDirNonDir: String?, copyUIDGID: String?): RequestConfig {
-    val localVariableBody: Any = inputStream.source()
+    val localVariableBody: Source = inputStream.source()
     val localVariableQuery: MultiValueMap = mutableMapOf<String, List<String>>()
       .apply {
         put("path", listOf(path))

api-client/src/main/kotlin/de/gesellix/docker/remote/api/client/ImageApi.kt

@@ -46,6 +46,7 @@ import kotlinx.coroutines.flow.collect
 import kotlinx.coroutines.launch
 import kotlinx.coroutines.runBlocking
 import kotlinx.coroutines.withTimeout
+import okio.Source
 import okio.source
 import java.io.InputStream
 import java.net.Proxy
@@ -741,37 +742,37 @@ class ImageApi(dockerClientConfig: DockerClientConfig = defaultClientConfig, pro
    * Export an image
    * Get a tarball containing all images and metadata for a repository.  If `name` is a specific name and tag (e.g. `ubuntu:latest`), then only that image (and its parents) are returned. If `name` is an image ID, similarly only that image (and its parents) are returned, but with the exclusion of the `repositories` file in the tarball, as there were no image names referenced.  ### Image tarball format  An image tarball contains one directory per image layer (named using its long ID), each containing these files:  - `VERSION`: currently `1.0` - the file format version - `json`: detailed layer information, similar to `docker inspect layer_id` - `layer.tar`: A tarfile containing the filesystem changes in this layer  The `layer.tar` file contains `aufs` style `.wh..wh.aufs` files and directories for storing attribute changes and deletions.  If the tarball defines a repository, the tarball should also include a `repositories` file at the root that contains a list of repository and tag names mapped to layer IDs.  ```json {   \"hello-world\": {     \"latest\": \"565a9d68a73f6706862bfe8409a7f659776d4d60a8d096eb4a3cbce6999cc2a1\"   } } ```
    * @param name Image name or ID
-   * @return java.io.File
+   * @return InputStream
    * @throws UnsupportedOperationException If the API returns an informational or redirection response
    * @throws ClientException If the API returns a client error response
    * @throws ServerException If the API returns a server error response
    */
   @Suppress("UNCHECKED_CAST")
   @Throws(UnsupportedOperationException::class, ClientException::class, ServerException::class)
-  fun imageGet(name: String): java.io.File {
+  fun imageGet(name: String): InputStream {
     return this.imageGetAll(Collections.singletonList(name))
   }
 
   /**
    * Export several images
    * Get a tarball containing all images and metadata for several image repositories.  For each value of the `names` parameter: if it is a specific name and tag (e.g. `ubuntu:latest`), then only that image (and its parents) are returned; if it is an image ID, similarly only that image (and its parents) are returned and there would be no names referenced in the 'repositories' file for this image ID.  For details on the format, see the [export image endpoint](#operation/ImageGet).
    * @param names Image names to filter by (optional)
-   * @return java.io.File
+   * @return InputStream
    * @throws UnsupportedOperationException If the API returns an informational or redirection response
    * @throws ClientException If the API returns a client error response
    * @throws ServerException If the API returns a server error response
    */
   @Suppress("UNCHECKED_CAST")
   @Throws(UnsupportedOperationException::class, ClientException::class, ServerException::class)
-  fun imageGetAll(names: List<String>?): java.io.File {
+  fun imageGetAll(names: List<String>?): InputStream {
     val localVariableConfig = imageGetAllRequestConfig(names = names)
 
-    val localVarResponse = request<java.io.File>(
+    val localVarResponse = request<InputStream>(
       localVariableConfig
     )
 
     return when (localVarResponse.responseType) {
-      ResponseType.Success -> (localVarResponse as Success<*>).data as java.io.File
+      ResponseType.Success -> (localVarResponse as Success<*>).data as InputStream
       ResponseType.Informational -> throw UnsupportedOperationException("Client does not support Informational responses.")
       ResponseType.Redirection -> throw UnsupportedOperationException("Client does not support Redirection responses.")
       ResponseType.ClientError -> {
@@ -999,7 +1000,7 @@ class ImageApi(dockerClientConfig: DockerClientConfig = defaultClientConfig, pro
   @Throws(UnsupportedOperationException::class, ClientException::class, ServerException::class)
   @JvmOverloads
   fun imageLoad(
-    quiet: Boolean?, imagesTarball: java.io.File?,
+    quiet: Boolean?, imagesTarball: InputStream?,
     callback: StreamCallback<CreateImageInfo?>? = null, timeoutMillis: Long? = null /*= 24.hours.toLongMilliseconds()*/
   ) {
     val localVariableConfig = imageLoadRequestConfig(quiet = quiet, imagesTarball = imagesTarball)
@@ -1048,8 +1049,8 @@ class ImageApi(dockerClientConfig: DockerClientConfig = defaultClientConfig, pro
    * @param imagesTarball Tar archive containing images (optional)
    * @return RequestConfig
    */
-  fun imageLoadRequestConfig(quiet: Boolean?, imagesTarball: java.io.File?): RequestConfig {
-    val localVariableBody: Any? = imagesTarball
+  fun imageLoadRequestConfig(quiet: Boolean?, imagesTarball: InputStream?): RequestConfig {
+    val localVariableBody: Source? = imagesTarball?.source()
     val localVariableQuery: MultiValueMap = mutableMapOf<String, List<String>>()
       .apply {
         if (quiet != null) {

api-client/src/main/kotlin/de/gesellix/docker/remote/api/client/PluginApi.kt

@@ -26,6 +26,9 @@ import de.gesellix.docker.remote.api.core.ResponseType
 import de.gesellix.docker.remote.api.core.ServerError
 import de.gesellix.docker.remote.api.core.ServerException
 import de.gesellix.docker.remote.api.core.Success
+import okio.Source
+import okio.source
+import java.io.InputStream
 import java.net.Proxy
 
 class PluginApi(dockerClientConfig: DockerClientConfig = defaultClientConfig, proxy: Proxy?) : ApiClient(dockerClientConfig, proxy) {
@@ -107,7 +110,7 @@ class PluginApi(dockerClientConfig: DockerClientConfig = defaultClientConfig, pr
    * @throws ServerException If the API returns a server error response
    */
   @Throws(UnsupportedOperationException::class, ClientException::class, ServerException::class)
-  fun pluginCreate(name: String, tarContext: java.io.File?) {
+  fun pluginCreate(name: String, tarContext: InputStream?) {
     val localVariableConfig = pluginCreateRequestConfig(name = name, tarContext = tarContext)
 
     val localVarResponse = request<Any?>(
@@ -136,8 +139,8 @@ class PluginApi(dockerClientConfig: DockerClientConfig = defaultClientConfig, pr
    * @param tarContext Path to tar containing plugin rootfs and manifest (optional)
    * @return RequestConfig
    */
-  fun pluginCreateRequestConfig(name: String, tarContext: java.io.File?): RequestConfig {
-    val localVariableBody: Any? = tarContext
+  fun pluginCreateRequestConfig(name: String, tarContext: InputStream?): RequestConfig {
+    val localVariableBody: Source? = tarContext?.source()
     val localVariableQuery: MultiValueMap = mutableMapOf<String, List<String>>()
       .apply {
         put("name", listOf(name))

api-client/src/main/kotlin/de/gesellix/docker/remote/api/client/ServiceApi.kt

@@ -297,7 +297,7 @@ class ServiceApi(dockerClientConfig: DockerClientConfig = defaultClientConfig, p
    * @param since Only return logs since this time, as a UNIX timestamp (optional, default to 0)
    * @param timestamps Add timestamps to every log line (optional, default to false)
    * @param tail Only return this number of log lines from the end of the logs. Specify as an integer or `all` to output all log lines.  (optional, default to "all")
-   * @return java.io.File
+   * @return void
    * @throws UnsupportedOperationException If the API returns an informational or redirection response
    * @throws ClientException If the API returns a client error response
    * @throws ServerException If the API returns a server error response

api-client/src/main/kotlin/de/gesellix/docker/remote/api/client/TaskApi.kt

@@ -168,7 +168,7 @@ class TaskApi(dockerClientConfig: DockerClientConfig = defaultClientConfig, prox
    * @param since Only return logs since this time, as a UNIX timestamp (optional, default to 0)
    * @param timestamps Add timestamps to every log line (optional, default to false)
    * @param tail Only return this number of log lines from the end of the logs. Specify as an integer or `all` to output all log lines.  (optional, default to "all")
-   * @return java.io.File
+   * @return void
    * @throws UnsupportedOperationException If the API returns an informational or redirection response
    * @throws ClientException If the API returns a client error response
    * @throws ServerException If the API returns a server error response

api-client/src/main/kotlin/de/gesellix/docker/remote/api/core/ApiClient.kt

@@ -25,6 +25,7 @@ import okhttp3.RequestBody.Companion.toRequestBody
 import okhttp3.ResponseBody
 import okio.Source
 import java.io.File
+import java.io.InputStream
 import java.lang.reflect.Type
 import java.net.Proxy
 import java.util.*
@@ -96,8 +97,8 @@ open class ApiClient(
 //    if (mediaType == null && body.contentLength() == 0L) {
 //      return null
 //    }
-    if (T::class.java == File::class.java) {
-      return body.consumeFile() as T
+    if (T::class.java == InputStream::class.java) {
+      return body.consumeInputStream() as T
     }
     return when (mediaType) {
       JsonMediaType -> when (type) {

api-client/src/main/kotlin/de/gesellix/docker/remote/api/core/ResponseConsumer.kt

@@ -11,6 +11,7 @@ import okhttp3.internal.closeQuietly
 import okio.appendingSink
 import okio.buffer
 import java.io.File
+import java.io.InputStream
 import java.lang.reflect.Type
 import java.nio.file.Files
 
@@ -27,6 +28,13 @@ fun ResponseBody?.consumeFile(): File? {
   return f
 }
 
+fun ResponseBody?.consumeInputStream(): InputStream? {
+  if (this == null) {
+    return null
+  }
+  return source().inputStream()
+}
+
 inline fun <reified T : Any?> ResponseBody?.consumeStream(mediaType: String?): Flow<T> {
   if (this == null) {
     return emptyFlow()

api-client/src/test/java/de/gesellix/docker/remote/api/client/ContainerApiIntegrationTest.java

@@ -31,7 +31,6 @@
 import org.slf4j.Logger;
 
 import java.io.File;
-import java.io.FileInputStream;
 import java.io.IOException;
 import java.io.InputStream;
 import java.time.Duration;
@@ -171,7 +170,13 @@ public void containerExport() {
         null
     );
     containerApi.containerCreate(containerCreateRequest, "container-export");
-    assertDoesNotThrow(() -> containerApi.containerExport("container-export"));
+    Long size = assertDoesNotThrow(() -> {
+      InputStream inputStream = containerApi.containerExport("container-export");
+      long byteCount = Okio.buffer(Okio.source(inputStream)).readAll(Okio.blackhole());
+      inputStream.close();
+      return byteCount;
+    });
+    assertTrue(size > 0);
     removeContainer(engineApiClient, "container-export");
   }
 
@@ -201,9 +206,10 @@ public void containerArchiveInfoGetAndPut() throws IOException {
     containerApi.containerCreate(containerCreateRequest, "container-archive-info-test");
     containerApi.containerStart("container-archive-info-test", null);
 
-    File archive = containerApi.containerArchive("container-archive-info-test", "/gattaca.txt");
+    InputStream archive = containerApi.containerArchive("container-archive-info-test", "/gattaca.txt");
     File extractedDir = new TarUtil().unTar(archive);
-    String fileContent = Okio.buffer(Okio.source(new File(extractedDir, "gattaca.txt"))).readUtf8();
+    File gattaca = new File(extractedDir, "gattaca.txt");
+    String fileContent = Okio.buffer(Okio.source(gattaca)).readUtf8();
     assertEquals("The wind\ncaught it.\n", fileContent.replaceAll("\r", ""));
 
     IdResponse containerExec = engineApiClient.getExecApi().containerExec(
@@ -214,8 +220,7 @@ public void containerArchiveInfoGetAndPut() throws IOException {
         containerExec.getId(),
         new ExecStartConfig(null, null));
 
-    InputStream archiveStream = new FileInputStream(archive);
-    containerApi.putContainerArchive("container-archive-info-test", "/tmp/test/", archiveStream, null, null);
+    containerApi.putContainerArchive("container-archive-info-test", "/tmp/test/", new TarUtil().tar(gattaca), null, null);
 
     Map<String, Object> archiveCopyInfo = (Map<String, Object>) containerApi.containerArchiveInfo("container-archive-info-test", "/tmp/test/gattaca.txt");
     assertEquals("gattaca.txt", archiveCopyInfo == null ? null : archiveCopyInfo.get("name"));

api-client/src/test/java/de/gesellix/docker/remote/api/client/ImageApiIntegrationTest.java

@@ -24,6 +24,7 @@
 import de.gesellix.docker.remote.api.testutil.TarUtil;
 import de.gesellix.docker.remote.api.testutil.TestImage;
 import de.gesellix.testutil.ResourceReader;
+import okio.Okio;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 import org.slf4j.Logger;
@@ -50,8 +51,6 @@
 
 import static de.gesellix.docker.remote.api.testutil.Constants.LABEL_KEY;
 import static de.gesellix.docker.remote.api.testutil.Constants.LABEL_VALUE;
-import static java.nio.file.Files.readAttributes;
-import static java.nio.file.LinkOption.NOFOLLOW_LINKS;
 import static java.util.Arrays.asList;
 import static java.util.Collections.singletonList;
 import static java.util.Collections.singletonMap;
@@ -154,7 +153,7 @@ public void imageCreatePullFromRemote() {
 
   @Test
   public void imageCreateImportFromUrl() throws IOException {
-    File tarFile = imageApi.imageGet(testImage.getImageWithTag());
+    InputStream tarFile = imageApi.imageGet(testImage.getImageWithTag());
     File destDir = new TarUtil().unTar(tarFile);
     File rootLayerTar = new ManifestUtil().getRootLayerLocation(destDir);
     URL importUrl = rootLayerTar.toURI().toURL();
@@ -172,7 +171,7 @@ public void imageCreateImportFromUrl() throws IOException {
 
   @Test
   public void imageCreateImportFromInputStream() throws IOException {
-    File tarFile = imageApi.imageGet(testImage.getImageWithTag());
+    InputStream tarFile = imageApi.imageGet(testImage.getImageWithTag());
     File destDir = new TarUtil().unTar(tarFile);
     File rootLayerTar = new ManifestUtil().getRootLayerLocation(destDir);
     try (InputStream source = new FileInputStream(rootLayerTar)) {
@@ -227,8 +226,10 @@ public void imageDelete() {
   @Test
   public void imageGet() throws IOException {
     imageApi.imageTag(testImage.getImageWithTag(), "test", "export");
-    File exportedImage = imageApi.imageGet("test:export");
-    assertTrue(16896 < Long.parseLong(readAttributes(exportedImage.toPath(), "size", NOFOLLOW_LINKS).get("size").toString()));
+    InputStream exportedImage = imageApi.imageGet("test:export");
+    long byteCount = Okio.buffer(Okio.source(exportedImage)).readAll(Okio.blackhole());
+    exportedImage.close();
+    assertTrue(16896 < byteCount);
 
     imageApi.imageDelete("test:export", null, null);
   }
@@ -238,8 +239,10 @@ public void imageGetAll() throws IOException {
     imageApi.imageTag(testImage.getImageWithTag(), "test", "export-all-1");
     imageApi.imageTag(testImage.getImageWithTag(), "test", "export-all-2");
 
-    File exportedImages = imageApi.imageGetAll(asList("test:export-all-1", "test:export-all-2"));
-    assertTrue(22016 < Long.parseLong(readAttributes(exportedImages.toPath(), "size", NOFOLLOW_LINKS).get("size").toString()));
+    InputStream exportedImages = imageApi.imageGetAll(asList("test:export-all-1", "test:export-all-2"));
+    long byteCount = Okio.buffer(Okio.source(exportedImages)).readAll(Okio.blackhole());
+    exportedImages.close();
+    assertTrue(22016 < byteCount);
 
     imageApi.imageDelete("test:export-all-1", null, null);
     imageApi.imageDelete("test:export-all-2", null, null);
@@ -250,7 +253,7 @@ public void imageLoad() {
     List<String> originalRepoDigests = imageApi.imageInspect(testImage.getImageWithTag()).getRepoDigests();
 
     imageApi.imageTag(testImage.getImageWithTag(), "test", "load-image");
-    File tarFile = imageApi.imageGet("test:load-image");
+    InputStream tarFile = imageApi.imageGet("test:load-image");
     imageApi.imageDelete("test:load-image", null, null);
 
     assertDoesNotThrow(() -> imageApi.imageLoad(false, tarFile));