/* * 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; import java.io.File; import java.io.IOException; import java.nio.file.Files; import java.nio.file.InvalidPathException; import java.nio.file.Path; import com.carrotsearch.randomizedtesting.RandomizedTest; import org.apache.tools.ant.taskdefs.condition.Os; import org.opensearch.gradle.test.GradleUnitTestCase; import org.gradle.api.Project; import org.gradle.testfixtures.ProjectBuilder; public class EmptyDirTaskTests extends GradleUnitTestCase { public void testCreateEmptyDir() throws Exception { Project project = ProjectBuilder.builder().build(); EmptyDirTask emptyDirTask = project.getTasks().create("emptyDirTask", EmptyDirTask.class); assertEquals(0755, emptyDirTask.getDirMode()); // generate a new temporary folder and make sure it does not exists File newEmptyFolder = getNewNonExistingTempFolderFile(project); emptyDirTask.setDir(newEmptyFolder); emptyDirTask.create(); assertTrue(newEmptyFolder.exists()); assertTrue(newEmptyFolder.isDirectory()); assertTrue(newEmptyFolder.canExecute()); assertTrue(newEmptyFolder.canRead()); assertTrue(newEmptyFolder.canWrite()); // cleanup newEmptyFolder.delete(); } public void testCreateEmptyDirNoPermissions() throws Exception { // Test depends on Posix file permissions RandomizedTest.assumeFalse("Functionality is Unix-like OS specific", Os.isFamily(Os.FAMILY_WINDOWS)); // Java's Files.setPosixFilePermissions is a NOOP inside a Docker container as // files are created by default with UID and GID = 0 (root). RandomizedTest.assumeFalse("Functionality doesn't work in Docker", isRunningInDocker()); Project project = ProjectBuilder.builder().build(); EmptyDirTask emptyDirTask = project.getTasks().create("emptyDirTask", EmptyDirTask.class); emptyDirTask.setDirMode(0000); // generate a new temporary folder and make sure it does not exists File newEmptyFolder = getNewNonExistingTempFolderFile(project); emptyDirTask.setDir(newEmptyFolder); emptyDirTask.create(); assertTrue(newEmptyFolder.exists()); assertTrue(newEmptyFolder.isDirectory()); assertFalse(newEmptyFolder.canExecute()); assertFalse(newEmptyFolder.canRead()); assertFalse(newEmptyFolder.canWrite()); // cleanup newEmptyFolder.delete(); } private File getNewNonExistingTempFolderFile(Project project) throws IOException { File newEmptyFolder = new File(project.getBuildDir(), "empty-dir"); assertFalse(newEmptyFolder.exists()); return newEmptyFolder; } private static boolean isRunningInDocker() { // Only reliable existing method but may be removed in future if (new File("/.dockerenv").exists()) { return true; } try { // Backup 1: look for 'docker' in one of the paths in /proc/1/cgroup if (Files.lines(Path.of("/proc/1/cgroup")).anyMatch(line -> line.contains("docker"))) { return true; } // Backup 2: look for 'docker' in overlay fs return Files.lines(Path.of("/proc/1/mounts")).anyMatch(line -> line.startsWith("overlay") && line.contains("docker")); } catch (InvalidPathException | IOException e) { return false; } } }