anishshri-db commented on code in PR #50508: URL: https://github.com/apache/spark/pull/50508#discussion_r2029578075
########## sql/core/src/test/scala/org/apache/spark/sql/execution/streaming/state/FailureInjectionCheckpointFileManager.scala: ########## @@ -0,0 +1,254 @@ +/* + * 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.sql.execution.streaming.state + +import java.io._ +import java.net.URI + +import org.apache.hadoop.conf.Configuration +import org.apache.hadoop.fs._ +import org.apache.hadoop.fs.permission.FsPermission +import org.apache.hadoop.util.Progressable + +import org.apache.spark.internal.Logging +import org.apache.spark.sql.execution.streaming.CheckpointFileManager.{CancellableFSDataOutputStream, RenameBasedFSDataOutputStream} +import org.apache.spark.sql.execution.streaming.FileSystemBasedCheckpointFileManager + +/** + * A wrapper file output stream that will throw exception in close() and put the underlying + * stream to FailureInjectionFileSystem.delayedStreams + * @param stream stream to be wrapped + */ +class DelayCloseFSDataOutputStreamWrapper(stream: CancellableFSDataOutputStream) + extends CancellableFSDataOutputStream(stream.getWrappedStream) with Logging { + val originalStream: CancellableFSDataOutputStream = stream + + var closed: Boolean = false + + override def close(): Unit = { + if (!closed) { + closed = true + FailureInjectionFileSystem.delayedStreams = + FailureInjectionFileSystem.delayedStreams :+ originalStream + throw new IOException("Fake File Stream Close Failure") + } + } + + /** Cancel is not needed in unit tests */ + override def cancel(): Unit = {} +} + +/** + * A wrapper checkpoint file manager that might inject functions in some function calls. + * Used in unit tests to simulate failure scenarios. + * This can be put into SQLConf.STREAMING_CHECKPOINT_FILE_MANAGER_CLASS to provide failure + * injection behavior. + * + * @param path + * @param hadoopConf + */ +class FailureInjectionCheckpointFileManager(path: Path, hadoopConf: Configuration) + extends FileSystemBasedCheckpointFileManager(path, hadoopConf) with Logging { + + override def createAtomic(path: Path, + overwriteIfPossible: Boolean): CancellableFSDataOutputStream = { + FailureInjectionFileSystem.failureCreateAtomicRegex.foreach { pattern => + if (path.toString.matches(pattern)) { + throw new IOException("Fake File System Create Atomic Failure") + } + } + + var shouldDelay = false + FailureInjectionFileSystem.createAtomicDelayCloseRegex.foreach { pattern => + if (path.toString.matches(pattern)) { + shouldDelay = true + } + } + val ret = new RenameBasedFSDataOutputStream(this, path, overwriteIfPossible) + if (shouldDelay) { + new DelayCloseFSDataOutputStreamWrapper(ret) + } else { + ret + } + } + + override def renameTempFile(srcPath: Path, dstPath: Path, overwriteIfPossible: Boolean): Unit = { + if (FailureInjectionFileSystem.allowOverwriteInRename || !fs.exists(dstPath)) { + super.renameTempFile(srcPath, dstPath, overwriteIfPossible) + } else { + logWarning(s"Skip renaming temp file $srcPath to $dstPath because it already exists.") + } + } + + override def list(path: Path, filter: PathFilter): Array[FileStatus] = { + super.list(path, filter) + } + + override def exists(path: Path): Boolean = { + if (FailureInjectionFileSystem.shouldFailExist) { + throw new IOException("Fake File Exists Failure") + } + super.exists(path) + } +} + +/** + * Contains a list of variables for failure ingestion conditions. + * These are singleton instances accessed by all instances of FailureInjectionCheckpointFileManager + * and FailureInjectionFileSystem. This allows a unit test to have a global control of failure + * and access to the delayed streams. + */ +object FailureInjectionFileSystem { + // File names matching this regex will cause the copyFromLocalFile to fail + var failPreCopyFromLocalFileNameRegex: Seq[String] = Seq.empty + // File names matching this regex will cause the createAtomic to fail and put the streams in + // `delayedStreams` + var createAtomicDelayCloseRegex: Seq[String] = Seq.empty + // File names matching this regex will cause the createAtomic() to fail + var failureCreateAtomicRegex: Seq[String] = Seq.empty + // If true, Exists() call will fail + var shouldFailExist: Boolean = false + // If true, simulate a case where rename() will not overwrite an existing file. + var allowOverwriteInRename: Boolean = true + + // List of streams that are delayed in close() based on `createAtomicDelayCloseRegex` + var delayedStreams: Seq[CancellableFSDataOutputStream] = Seq.empty +} + +/** + * A wrapper FileSystem that inject some failures. This class can used to replace the + * FileSystem in RocksDBFileManager. + * @param innerFs the FileSystem to be wrapped + */ +class FailureInjectionFileSystem(innerFs: FileSystem) extends FileSystem { + + override def getConf: Configuration = innerFs.getConf + + override def mkdirs(f: Path, permission: FsPermission): Boolean = innerFs.mkdirs(f, permission) + + override def rename(src: Path, dst: Path): Boolean = innerFs.rename(src, dst) + + override def getUri: URI = innerFs.getUri + + override def open(f: Path, bufferSize: Int): FSDataInputStream = innerFs.open(f, bufferSize) + + override def create( + f: Path, + permission: FsPermission, + overwrite: Boolean, + bufferSize: Int, + replication: Short, + blockSize: Long, + progress: Progressable): FSDataOutputStream = + innerFs.create(f, permission, overwrite, bufferSize, replication, blockSize, progress) + + override def append(f: Path, bufferSize: Int, progress: Progressable): FSDataOutputStream = + innerFs.append(f, bufferSize, progress) + + override def delete(f: Path, recursive: Boolean): Boolean = innerFs.delete(f, recursive) + + override def listStatus(f: Path): Array[FileStatus] = innerFs.listStatus(f) + + override def setWorkingDirectory(new_dir: Path): Unit = innerFs.setWorkingDirectory(new_dir) + + override def getWorkingDirectory: Path = innerFs.getWorkingDirectory + + override def getFileStatus(f: Path): FileStatus = innerFs.getFileStatus(f) + + override def copyFromLocalFile(src: Path, dst: Path): Unit = { + FailureInjectionFileSystem.failPreCopyFromLocalFileNameRegex.foreach { pattern => + if (src.toString.matches(pattern)) { + throw new IOException(s"Injected failure due to source path matching pattern: $pattern") + } + } + + innerFs.copyFromLocalFile(src, dst) + } +} + +/** + * A wrapper RocksDB State Store Provider that replaces FileSystem used in RocksDBFileManager + * to FailureInjectionFileSystem. + */ +class FailureInjectionRocksDBStateStoreProvider extends RocksDBStateStoreProvider { + override def createRocksDB( + dfsRootDir: String, + conf: RocksDBConf, + localRootDir: File, + hadoopConf: Configuration, + loggingId: String, + useColumnFamilies: Boolean, + enableStateStoreCheckpointIds: Boolean, + partitionId: Int): RocksDB = { + FailureInjectionRocksDBStateStoreProvider.createRocksDBWithFaultInjection( + dfsRootDir, + conf, + localRootDir, + hadoopConf, + loggingId, + useColumnFamilies, + enableStateStoreCheckpointIds, + partitionId) + } +} + +object FailureInjectionRocksDBStateStoreProvider { + /** + * RocksDBFieManager is created by RocksDB class where it creates a default FileSystem. + * we made RocksDB create a RocksDBFileManager but a different FileSystem here. Review Comment: nit: `We make RocksDB create a RocksDBFileManager that uses a different FileSystem here` -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: reviews-unsubscr...@spark.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org --------------------------------------------------------------------- To unsubscribe, e-mail: reviews-unsubscr...@spark.apache.org For additional commands, e-mail: reviews-h...@spark.apache.org
