slider-core/src/test/groovy/org/apache/slider/client/TestInstallKeytab.groovy

/*
 * 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.slider.client

import org.apache.commons.io.FileUtils
import org.apache.hadoop.fs.FileUtil
import org.apache.hadoop.fs.Path
import org.apache.hadoop.fs.RawLocalFileSystem
import org.apache.hadoop.yarn.conf.YarnConfiguration
import org.apache.slider.common.params.Arguments
import org.apache.slider.common.params.ClientArgs
import org.apache.slider.common.tools.SliderFileSystem
import org.apache.slider.common.tools.SliderUtils
import org.apache.slider.core.exceptions.BadCommandArgumentsException
import org.apache.slider.core.exceptions.SliderException
import org.apache.slider.core.main.ServiceLauncher
import org.apache.slider.core.main.ServiceLauncherBaseTest
import org.junit.Before
import org.junit.Test

/**
 * Test a keytab installation
 */
class TestInstallKeytab extends ServiceLauncherBaseTest {
  final shouldFail = new GroovyTestCase().&shouldFail

  private static SliderFileSystem testFileSystem

  @Before
  public void setupFilesystem() {
    org.apache.hadoop.fs.FileSystem fileSystem = new RawLocalFileSystem()
    YarnConfiguration configuration = SliderUtils.createConfiguration()
    fileSystem.setConf(configuration)
    testFileSystem = new SliderFileSystem(fileSystem, configuration)
  }

  @Test
  public void testInstallKeytab() throws Throwable {
    // create a mock keytab file
    File localKeytab =
      FileUtil.createLocalTempFile(tempLocation, "test", true);
    String contents = UUID.randomUUID().toString()
    FileUtils.write(localKeytab, contents);
    YarnConfiguration conf = SliderUtils.createConfiguration()
    ServiceLauncher launcher = launch(TestSliderClient,
                                      conf,
                                      [
                                          ClientArgs.ACTION_INSTALL_KEYTAB,
                                          ClientArgs.ARG_KEYTAB,
                                          localKeytab.absolutePath,
                                          Arguments.ARG_FOLDER,
                                          "testFolder"])
    Path installedPath = new Path(testFileSystem.buildKeytabInstallationDirPath("testFolder"), localKeytab.getName())
    File installedKeytab = new File(installedPath.toUri().path)
    assert installedKeytab.exists()
    assert FileUtils.readFileToString(installedKeytab).equals(
        FileUtils.readFileToString(localKeytab))
  }

  @Test
  public void testInstallKeytabWithNoFolder() throws Throwable {
    // create a mock keytab file
    File localKeytab =
      FileUtil.createLocalTempFile(tempLocation, "test", true);
    String contents = UUID.randomUUID().toString()
    FileUtils.write(localKeytab, contents);
    YarnConfiguration conf = SliderUtils.createConfiguration()
    shouldFail(BadCommandArgumentsException) {
      ServiceLauncher launcher = launch(TestSliderClient,
                                        conf,
                                        [
                                            ClientArgs.ACTION_INSTALL_KEYTAB,
                                            ClientArgs.ARG_KEYTAB,
                                            localKeytab.absolutePath])
    }
  }

  @Test
  public void testInstallKeytabWithNoKeytab() throws Throwable {
    // create a mock keytab file
    File localKeytab =
      FileUtil.createLocalTempFile(tempLocation, "test", true);
    String contents = UUID.randomUUID().toString()
    FileUtils.write(localKeytab, contents);
    YarnConfiguration conf = SliderUtils.createConfiguration()
    shouldFail(BadCommandArgumentsException) {
      ServiceLauncher launcher = launch(TestSliderClient,
                                        conf,
                                        [
                                            ClientArgs.ACTION_INSTALL_KEYTAB,
                                            ClientArgs.ARG_FOLDER,
                                            "testFolder"])
    }
  }

  @Test
  public void testInstallKeytabAllowingOverwrite() throws Throwable {
    // create a mock keytab file
    File localKeytab =
      FileUtil.createLocalTempFile(tempLocation, "test", true);
    String contents = UUID.randomUUID().toString()
    FileUtils.write(localKeytab, contents);
    YarnConfiguration conf = SliderUtils.createConfiguration()
    ServiceLauncher launcher = launch(TestSliderClient,
                                      conf,
                                      [
                                          ClientArgs.ACTION_INSTALL_KEYTAB,
                                          ClientArgs.ARG_KEYTAB,
                                          localKeytab.absolutePath,
                                          Arguments.ARG_FOLDER,
                                          "testFolder"])
    Path installedPath = new Path(testFileSystem.buildKeytabInstallationDirPath("testFolder"), localKeytab.getName())
    File installedKeytab = new File(installedPath.toUri().path)
    assert installedKeytab.exists()
    assert FileUtils.readFileToString(installedKeytab).equals(FileUtils.readFileToString(localKeytab))
    launcher = launch(TestSliderClient,
                      conf,
                      [
                          ClientArgs.ACTION_INSTALL_KEYTAB,
                          ClientArgs.ARG_KEYTAB,
                          localKeytab.absolutePath,
                          Arguments.ARG_FOLDER,
                          "testFolder",
                          Arguments.ARG_OVERWRITE]
    )
    assert installedKeytab.exists()
    assert FileUtils.readFileToString(installedKeytab).equals(
        FileUtils.readFileToString(localKeytab))
  }

  @Test
  public void testInstallKeytabNotAllowingOverwrite() throws Throwable {
    // create a mock keytab file
    File localKeytab =
      FileUtil.createLocalTempFile(tempLocation, "test", true);
    String contents = UUID.randomUUID().toString()
    FileUtils.write(localKeytab, contents);
    YarnConfiguration conf = SliderUtils.createConfiguration()
    ServiceLauncher launcher = launch(TestSliderClient,
                                      conf,
                                      [
                                          ClientArgs.ACTION_INSTALL_KEYTAB,
                                          ClientArgs.ARG_KEYTAB,
                                          localKeytab.absolutePath,
                                          Arguments.ARG_FOLDER,
                                          "testFolder"])
    Path installedPath = new Path(testFileSystem.buildKeytabInstallationDirPath("testFolder"), localKeytab.getName())
    File installedKeytab = new File(installedPath.toUri().path)
    assert installedKeytab.exists()
    assert FileUtils.readFileToString(installedKeytab).equals(FileUtils.readFileToString(localKeytab))
    shouldFail(BadCommandArgumentsException) {
      launcher = launch(TestSliderClient,
                        conf,
                        [
                            ClientArgs.ACTION_INSTALL_KEYTAB,
                            ClientArgs.ARG_KEYTAB,
                            localKeytab.absolutePath,
                            Arguments.ARG_FOLDER,
                            "testFolder"])
    }
  }

  @Test
  public void testInstallKeytabWithMissingKeytab() throws Throwable {
    // create a mock keytab file
    YarnConfiguration conf = SliderUtils.createConfiguration()
    shouldFail(BadCommandArgumentsException) {
      ServiceLauncher launcher = launch(TestSliderClient,
                                        conf,
                                        [
                                            ClientArgs.ACTION_INSTALL_KEYTAB,
                                            ClientArgs.ARG_KEYTAB,
                                            "HeyIDontExist.keytab",
                                            Arguments.ARG_FOLDER,
                                            "testFolder"])
    }
  }

  private File getTempLocation () {
    return new File(System.getProperty("user.dir") + "/target");
  }

  static class TestSliderClient extends SliderClient {
    public TestSliderClient() {
      super()
    }

    @Override
    protected void initHadoopBinding() throws IOException, SliderException {
      sliderFileSystem = testFileSystem
    }

  }
}