com.bmuschko.gradle.docker.tasks.image.DockerListImages.groovy Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of gradle-docker-plugin Show documentation

Gradle plugin for managing Docker images and containers.

There is a newer version: 6.7.0

/*
 * Copyright 2014 the original author or authors.
 *
 * 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.bmuschko.gradle.docker.tasks.image

import com.bmuschko.gradle.docker.tasks.AbstractDockerRemoteApiTask
import com.github.dockerjava.api.DockerClient
import com.github.dockerjava.api.command.ListImagesCmd
import com.github.dockerjava.api.model.Image
import org.gradle.api.Action
import org.gradle.api.provider.Property
import org.gradle.api.tasks.Input
import org.gradle.api.tasks.Optional

class DockerListImages extends AbstractDockerRemoteApiTask {

    @Input
    @Optional
    final Property showAll = project.objects.property(Boolean)

    @Input
    @Optional
    final Property dangling = project.objects.property(Boolean)

    @Input
    @Optional
    final Property> labels = project.objects.property(Map)

    @Input
    @Optional
    final Property imageName = project.objects.property(String)

    DockerListImages() {
        defaultResponseHandling()
    }

    @Override
    void runRemoteCommand(DockerClient dockerClient) {
        ListImagesCmd listImagesCmd = dockerClient.listImagesCmd()

        if (showAll.getOrNull()) {
            listImagesCmd.withShowAll(showAll.get())
        }

        if (dangling.getOrNull()) {
            listImagesCmd.withDanglingFilter(dangling.get())
        }

        if (labels.getOrNull()) {
            listImagesCmd.withLabelFilter(labels.get().collectEntries { [it.key, it.value.toString()] })
        }

        if (imageName.getOrNull()) {
            listImagesCmd.withImageNameFilter(imageName.get())
        }

        List images = listImagesCmd.exec()

        if (nextHandler) {
            for(image in images) {
                nextHandler.execute(image)
            }
        }
    }

    private void defaultResponseHandling() {
        Action action = new Action() {
            @Override
            void execute(Image image) {
                logger.quiet "Repository Tags : ${image.repoTags?.join(', ')}"
                logger.quiet "Image ID        : $image.id"
                logger.quiet "Created         : ${new Date(image.created * 1000)}"
                logger.quiet "Virtual Size    : $image.virtualSize"
                logger.quiet "-----------------------------------------------"
            }
        }

        nextHandler = action
    }
}