/**
 * 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.hadoop.mapred;

import java.io.File;
import java.io.IOException;
import java.util.concurrent.CountDownLatch;

import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;

import org.apache.hadoop.conf.Configuration;
import org.apache.hadoop.fs.FileStatus;
import org.apache.hadoop.fs.FileSystem;
import org.apache.hadoop.fs.FileUtil;
import org.apache.hadoop.fs.LocalFileSystem;
import org.apache.hadoop.fs.Path;
import org.apache.hadoop.fs.PathFilter;
import org.apache.hadoop.test.AbstractHadoopTestBase;
import org.apache.hadoop.test.GenericTestUtils;
import org.apache.hadoop.util.concurrent.SubjectInheritingThread;

import static org.junit.jupiter.api.Assertions.assertTrue;

/**
 *  Test that the executor service has been shut down
 *  when the LocatedFileStatusFetcher is interrupted.
 */
public class TestLocatedFileStatusFetcher extends AbstractHadoopTestBase {

  private Configuration conf;
  private FileSystem fileSys;
  private boolean mkdirs;
  private File dir = GenericTestUtils.getTestDir("test-lfs-fetcher");
  private static final CountDownLatch LATCH = new CountDownLatch(1);

  @BeforeEach
  public void setup() throws Exception {
    conf = new Configuration(false);
    conf.set("fs.file.impl", MockFileSystem.class.getName());
    fileSys = FileSystem.getLocal(conf);
  }

  @AfterEach
  public void after() {
    if (mkdirs) {
      FileUtil.fullyDelete(dir);
    }
  }

  @Test
  public void testExecutorsShutDown() throws Exception {
    Path scanPath = new Path(dir.getAbsolutePath());
    mkdirs = fileSys.mkdirs(scanPath);
    Path[] dirs = new Path[] {scanPath};
    final LocatedFileStatusFetcher fetcher = new LocatedFileStatusFetcher(conf,
        dirs, true, new PathFilter() {
          @Override
          public boolean accept(Path path) {
            return true;
          }
        }, true);

    SubjectInheritingThread t = new SubjectInheritingThread() {
      @Override
      public void work() {
        try {
          fetcher.getFileStatuses();
        } catch (Exception e) {
          // This should interrupt condition.await()
          assertTrue(e instanceof InterruptedException);
        }
      }
    };

    t.start();
    LATCH.await();

    t.interrupt();
    t.join();
    // Check the status for executor service
    assertTrue(fetcher.getListeningExecutorService().isShutdown(),
        "The executor service should have been shut down");
  }

  static class MockFileSystem extends LocalFileSystem {
    @Override
    public FileStatus[] globStatus(Path pathPattern, PathFilter filter)
        throws IOException {
      // The executor service now is running tasks
      LATCH.countDown();
      try {
        // Try to sleep some time to
        // let LocatedFileStatusFetcher#getFileStatuses be interrupted before
        // the getting file info task finishes.
        Thread.sleep(5000);
      } catch (InterruptedException e) {
        // Ignore this exception
      }
      return super.globStatus(pathPattern, filter);
    }

  }

}
