/* * SPDX-License-Identifier: Apache-2.0 * * The OpenSearch Contributors require contributions made to * this file be licensed under the Apache-2.0 license or a * compatible open source license. */ /* * Licensed to Elasticsearch under one or more contributor * license agreements. See the NOTICE file distributed with * this work for additional information regarding copyright * ownership. Elasticsearch licenses this file to you 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. */ /* * Modifications Copyright OpenSearch Contributors. See * GitHub history for details. */ package org.opensearch.gradle.docker; import org.gradle.api.Plugin; import org.gradle.api.Project; import org.gradle.api.Task; import org.gradle.api.provider.Provider; import java.io.File; import java.util.List; import java.util.stream.Collectors; /** * Plugin providing {@link DockerSupportService} for detecting Docker installations and determining requirements for Docker-based * OpenSearch build tasks. */ public class DockerSupportPlugin implements Plugin { public static final String DOCKER_SUPPORT_SERVICE_NAME = "dockerSupportService"; public static final String DOCKER_ON_LINUX_EXCLUSIONS_FILE = ".ci/dockerOnLinuxExclusions"; @Override public void apply(Project project) { if (project != project.getRootProject()) { throw new IllegalStateException(this.getClass().getName() + " can only be applied to the root project."); } Provider dockerSupportServiceProvider = project.getGradle() .getSharedServices() .registerIfAbsent(DOCKER_SUPPORT_SERVICE_NAME, DockerSupportService.class, spec -> spec.parameters(params -> { params.setExclusionsFile(new File(project.getRootDir(), DOCKER_ON_LINUX_EXCLUSIONS_FILE)); })); // Ensure that if we are trying to run any DockerBuildTask tasks, we assert an available Docker installation exists project.getGradle().getTaskGraph().whenReady(graph -> { List dockerTasks = graph.getAllTasks() .stream() .filter(task -> task instanceof DockerBuildTask) .map(Task::getPath) .collect(Collectors.toList()); if (dockerTasks.isEmpty() == false) { dockerSupportServiceProvider.get().failIfDockerUnavailable(dockerTasks); } }); } }