/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF 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.
 */

package org.apache.flink.runtime.clusterframework.overlays;

import org.apache.flink.configuration.Configuration;
import org.apache.flink.core.fs.Path;
import org.apache.flink.core.testutils.CommonTestUtils;
import org.apache.flink.runtime.clusterframework.ContainerSpecification;

import org.junit.Rule;
import org.junit.Test;
import org.junit.rules.TemporaryFolder;

import java.io.File;
import java.io.IOException;
import java.util.HashMap;
import java.util.Map;

import static org.apache.flink.configuration.ConfigConstants.ENV_FLINK_BIN_DIR;
import static org.apache.flink.configuration.ConfigConstants.ENV_FLINK_CONF_DIR;
import static org.apache.flink.configuration.ConfigConstants.ENV_FLINK_LIB_DIR;
import static org.apache.flink.configuration.ConfigConstants.ENV_FLINK_PLUGINS_DIR;
import static org.apache.flink.runtime.clusterframework.overlays.FlinkDistributionOverlay.TARGET_ROOT;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.fail;

public class FlinkDistributionOverlayTest extends ContainerOverlayTestBase {

	@Rule
	public TemporaryFolder tempFolder = new TemporaryFolder();

	@Test
	public void testConfigure() throws Exception {
		File binFolder = tempFolder.newFolder("bin");
		File libFolder = tempFolder.newFolder("lib");
		File pluginsFolder = tempFolder.newFolder("plugins");
		File confFolder = tempFolder.newFolder("conf");

		Path[] files = createPaths(
			tempFolder.getRoot(),
			"bin/config.sh",
			"bin/taskmanager.sh",
			"lib/foo.jar",
			"lib/A/foo.jar",
			"lib/B/foo.jar",
			"lib/B/bar.jar",
			"plugins/P1/plugin1a.jar",
			"plugins/P1/plugin1b.jar",
			"plugins/P2/plugin2.jar");

		testConfigure(binFolder, libFolder, pluginsFolder, confFolder, files);
	}

	private void testConfigure(
			File binFolder,
			File libFolder,
			File pluginsFolder,
			File confFolder,
			Path[] files) throws IOException {
		ContainerSpecification containerSpecification = new ContainerSpecification();
		FlinkDistributionOverlay overlay = new FlinkDistributionOverlay(
			binFolder,
			confFolder,
			libFolder,
			pluginsFolder);
		overlay.configure(containerSpecification);

		for(Path file : files) {
			checkArtifact(containerSpecification, new Path(TARGET_ROOT, file.toString()));
		}
	}

	@Test
	public void testBuilderFromEnvironment() throws Exception {
		Configuration conf = new Configuration();

		File binFolder = tempFolder.newFolder("bin");
		File libFolder = tempFolder.newFolder("lib");
		File pluginsFolder = tempFolder.newFolder("plugins");
		File confFolder = tempFolder.newFolder("conf");

		// adjust the test environment for the purposes of this test
		Map<String, String> map = new HashMap<String, String>(System.getenv());
		map.put(ENV_FLINK_BIN_DIR, binFolder.getAbsolutePath());
		map.put(ENV_FLINK_LIB_DIR, libFolder.getAbsolutePath());
		map.put(ENV_FLINK_PLUGINS_DIR, pluginsFolder.getAbsolutePath());
		map.put(ENV_FLINK_CONF_DIR, confFolder.getAbsolutePath());
 		CommonTestUtils.setEnv(map);

		FlinkDistributionOverlay.Builder builder = FlinkDistributionOverlay.newBuilder().fromEnvironment(conf);

		assertEquals(binFolder.getAbsolutePath(), builder.flinkBinPath.getAbsolutePath());
		assertEquals(libFolder.getAbsolutePath(), builder.flinkLibPath.getAbsolutePath());
		final File flinkPluginsPath = builder.flinkPluginsPath;
		assertNotNull(flinkPluginsPath);
		assertEquals(pluginsFolder.getAbsolutePath(), flinkPluginsPath.getAbsolutePath());
		assertEquals(confFolder.getAbsolutePath(), builder.flinkConfPath.getAbsolutePath());
	}

	@Test
	public void testBuilderFromEnvironmentBad() throws Exception {
		testBuilderFromEnvironmentBad(ENV_FLINK_BIN_DIR);
		testBuilderFromEnvironmentBad(ENV_FLINK_LIB_DIR);
		testBuilderFromEnvironmentBad(ENV_FLINK_PLUGINS_DIR);
		testBuilderFromEnvironmentBad(ENV_FLINK_CONF_DIR);
	}

	public void testBuilderFromEnvironmentBad(String obligatoryEnvironmentVariable) throws Exception {
		Configuration conf = new Configuration();

		// adjust the test environment for the purposes of this test
		Map<String, String> map = new HashMap<>(System.getenv());
		map.remove(obligatoryEnvironmentVariable);
		CommonTestUtils.setEnv(map);

		try {
			FlinkDistributionOverlay.Builder builder = FlinkDistributionOverlay.newBuilder().fromEnvironment(conf);
			fail();
		}
		catch(IllegalStateException e) {
			// expected
		}
	}
}

@@ -2982,16 +2982,17 @@
 ;%0A%0A%09%09for
+ 
 (Path fi
@@ -3794,17 +3794,16 @@
 ath());%0A
- 
 %09%09Common
@@ -5138,16 +5138,15 @@
 %0A%09%09%7D
-%0A%09%09
+ 
 catch
+ 
 (Ill

Fix checkstyle violations in FlinkDistributionOverlayTest