/*
 * 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.spark

import org.apache.spark.deploy.SparkHadoopUtil
import org.apache.spark.internal.config
import org.apache.spark.network.TransportContext
import org.apache.spark.network.netty.SparkTransportConf
import org.apache.spark.network.shuffle.ExternalBlockHandler
import org.apache.spark.util.SslTestUtils

/**
 * This suite creates an external shuffle server and routes all shuffle fetches through it.
 * Note that failures in this suite may arise due to changes in Spark that invalidate expectations
 * set up in `ExternalShuffleBlockHandler`, such as changing the format of shuffle files or how
 * we hash files into folders.
 */
class SslExternalShuffleServiceSuite extends ExternalShuffleServiceSuite {

  override def initializeHandlers(): Unit = {
    SslTestUtils.updateWithSSLConfig(conf)
    val hadoopConf = SparkHadoopUtil.get.newConfiguration(conf);
    // Show that we can successfully inherit options defined in the `spark.ssl` namespace
    val defaultSslOptions = SSLOptions.parse(conf, hadoopConf, "spark.ssl")
    val sslOptions = SSLOptions.parse(
      conf, hadoopConf, "spark.ssl.rpc", defaults = Some(defaultSslOptions))
    val transportConf = SparkTransportConf.fromSparkConf(
      conf, "shuffle", numUsableCores = 2, sslOptions = Some(sslOptions))

    rpcHandler = new ExternalBlockHandler(transportConf, null)
    transportContext = new TransportContext(transportConf, rpcHandler)
    server = transportContext.createServer()

    conf.set(config.SHUFFLE_MANAGER, "sort")
    conf.set(config.SHUFFLE_SERVICE_ENABLED, true)
    conf.set(config.SHUFFLE_SERVICE_PORT, server.getPort)
  }
}
