Skip to content

[flink] Extract shared checkpoint/savepoint utilities to base class #2761

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
MehulBatra wants to merge 3 commits into
base: main
Choose a base branch
from
Open

[flink] Extract shared checkpoint/savepoint utilities to base class #2761

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
390bcab
Extract shared checkpoint/savepoint utilities to base class
MehulBatra Mar 1, 2026
16452a6
address comments
MehulBatra Mar 2, 2026
6ee38dd
fix ci
MehulBatra Mar 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 1 addition & 50 deletions ...ss-flink-common/src/test/java/org/apache/fluss/flink/source/BinlogVirtualTableITCase.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,10 +29,6 @@
import org.apache.fluss.server.testutils.FlussClusterExtension;
import org.apache.fluss.utils.clock.ManualClock;

import org.apache.flink.api.common.JobID;
import org.apache.flink.configuration.CheckpointingOptions;
import org.apache.flink.configuration.MemorySize;
import org.apache.flink.configuration.StateBackendOptions;
import org.apache.flink.core.execution.SavepointFormatType;
import org.apache.flink.runtime.testutils.MiniClusterResourceConfiguration;
import org.apache.flink.streaming.api.environment.StreamExecutionEnvironment;
Expand All @@ -47,11 +43,9 @@
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.RegisterExtension;
import org.junit.jupiter.api.io.TempDir;

import javax.annotation.Nullable;

import java.io.File;
import java.time.Duration;
import java.util.ArrayList;
import java.util.Arrays;
Expand All @@ -62,18 +56,14 @@
import static org.apache.fluss.flink.FlinkConnectorOptions.BOOTSTRAP_SERVERS;
import static org.apache.fluss.flink.source.testutils.FlinkRowAssertionsUtils.collectRowsWithTimeout;
import static org.apache.fluss.flink.utils.FlinkTestBase.writeRows;
import static org.apache.fluss.server.testutils.FlussClusterExtension.BUILTIN_DATABASE;
import static org.apache.fluss.testutils.DataTestUtils.row;
import static org.apache.fluss.testutils.common.CommonTestUtils.waitUntil;
import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.assertThatThrownBy;

/** Integration test for $binlog virtual table functionality. */
abstract class BinlogVirtualTableITCase {
abstract class BinlogVirtualTableITCase extends FlussVirtualTableITCaseBase {

protected static final ManualClock CLOCK = new ManualClock();
@TempDir public static File checkpointDir;
@TempDir public static File savepointDir;

@RegisterExtension
public static final FlussClusterExtension FLUSS_CLUSTER_EXTENSION =
Expand Down Expand Up @@ -156,12 +146,6 @@ private StreamTableEnvironment initTableEnvironment(@Nullable String savepointPa
return tEnv;
}

@AfterEach
void after() {
tEnv.useDatabase(BUILTIN_DATABASE);
tEnv.executeSql(String.format("drop database %s cascade", DEFAULT_DB));
}

/** Deletes rows from a primary key table using the proper delete API. */
protected static void deleteRows(
Connection connection, TablePath tablePath, List<InternalRow> rows) throws Exception {
Expand Down Expand Up @@ -476,37 +460,4 @@ public void testBinlogWithLatestScanStartupMode() throws Exception {
// Cleanup job
insertResult.getJobClient().get().cancel().get();
}

private static org.apache.flink.configuration.Configuration getFileBasedCheckpointsConfig(
File savepointDir) {
return getFileBasedCheckpointsConfig(savepointDir.toURI().toString());
}

private static org.apache.flink.configuration.Configuration getFileBasedCheckpointsConfig(
final String savepointDir) {
final org.apache.flink.configuration.Configuration config =
new org.apache.flink.configuration.Configuration();
config.set(StateBackendOptions.STATE_BACKEND, "hashmap");
config.set(CheckpointingOptions.CHECKPOINTS_DIRECTORY, checkpointDir.toURI().toString());
config.set(CheckpointingOptions.FS_SMALL_FILE_THRESHOLD, MemorySize.ZERO);
config.set(CheckpointingOptions.SAVEPOINT_DIRECTORY, savepointDir);
return config;
}

protected static void waitForCheckpoint(JobID jobId) {
String jobIdStr = jobId.toHexString();
waitUntil(
() -> {
File jobCheckpointDir = new File(checkpointDir, jobIdStr);
if (!jobCheckpointDir.exists()) {
return false;
}
File[] checkpoints =
jobCheckpointDir.listFiles(
f -> f.isDirectory() && f.getName().startsWith("chk-"));
return checkpoints != null && checkpoints.length > 0;
},
Duration.ofSeconds(60),
"Timeout waiting for checkpoint for job " + jobIdStr);
}
}
44 changes: 1 addition & 43 deletions ...flink-common/src/test/java/org/apache/fluss/flink/source/ChangelogVirtualTableITCase.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,10 +29,6 @@
import org.apache.fluss.server.testutils.FlussClusterExtension;
import org.apache.fluss.utils.clock.ManualClock;

import org.apache.flink.api.common.JobID;
import org.apache.flink.configuration.CheckpointingOptions;
import org.apache.flink.configuration.MemorySize;
import org.apache.flink.configuration.StateBackendOptions;
import org.apache.flink.core.execution.SavepointFormatType;
import org.apache.flink.runtime.testutils.MiniClusterResourceConfiguration;
import org.apache.flink.streaming.api.environment.StreamExecutionEnvironment;
Expand All @@ -47,11 +43,9 @@
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.RegisterExtension;
import org.junit.jupiter.api.io.TempDir;

import javax.annotation.Nullable;

import java.io.File;
import java.time.Duration;
import java.util.ArrayList;
import java.util.Arrays;
Expand All @@ -62,15 +56,12 @@
import static org.apache.fluss.flink.source.testutils.FlinkRowAssertionsUtils.collectRowsWithTimeout;
import static org.apache.fluss.flink.utils.FlinkTestBase.writeRows;
import static org.apache.fluss.testutils.DataTestUtils.row;
import static org.apache.fluss.testutils.common.CommonTestUtils.waitUntil;
import static org.assertj.core.api.Assertions.assertThat;

/** Integration test for $changelog virtual table functionality. */
abstract class ChangelogVirtualTableITCase {
abstract class ChangelogVirtualTableITCase extends FlussVirtualTableITCaseBase {

protected static final ManualClock CLOCK = new ManualClock();
@TempDir public static File checkpointDir;
@TempDir public static File savepointDir;

@RegisterExtension
public static final FlussClusterExtension FLUSS_CLUSTER_EXTENSION =
Expand Down Expand Up @@ -533,37 +524,4 @@ public void testChangelogWithPartitionedTable() throws Exception {

rowIter.close();
}

private static org.apache.flink.configuration.Configuration getFileBasedCheckpointsConfig(
File savepointDir) {
return getFileBasedCheckpointsConfig(savepointDir.toURI().toString());
}

private static org.apache.flink.configuration.Configuration getFileBasedCheckpointsConfig(
final String savepointDir) {
final org.apache.flink.configuration.Configuration config =
new org.apache.flink.configuration.Configuration();
config.set(StateBackendOptions.STATE_BACKEND, "hashmap");
config.set(CheckpointingOptions.CHECKPOINTS_DIRECTORY, checkpointDir.toURI().toString());
config.set(CheckpointingOptions.FS_SMALL_FILE_THRESHOLD, MemorySize.ZERO);
config.set(CheckpointingOptions.SAVEPOINT_DIRECTORY, savepointDir);
return config;
}

protected static void waitForCheckpoint(JobID jobId) {
String jobIdStr = jobId.toHexString();
waitUntil(
() -> {
File jobCheckpointDir = new File(checkpointDir, jobIdStr);
if (!jobCheckpointDir.exists()) {
return false;
}
File[] checkpoints =
jobCheckpointDir.listFiles(
f -> f.isDirectory() && f.getName().startsWith("chk-"));
return checkpoints != null && checkpoints.length > 0;
},
Duration.ofSeconds(60),
"Timeout waiting for checkpoint for job " + jobIdStr);
}
}
85 changes: 85 additions & 0 deletions ...flink-common/src/test/java/org/apache/fluss/flink/source/FlussVirtualTableITCaseBase.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
/*
* 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.fluss.flink.source;

import org.apache.flink.api.common.JobID;
import org.apache.flink.configuration.CheckpointingOptions;
import org.apache.flink.configuration.Configuration;
import org.apache.flink.configuration.MemorySize;
import org.apache.flink.configuration.StateBackendOptions;
import org.junit.jupiter.api.io.TempDir;

import java.io.File;
import java.time.Duration;

import static org.apache.fluss.testutils.common.CommonTestUtils.waitUntil;

/**
* Base class for virtual table integration tests that require checkpoint and savepoint support.
* This class provides shared utilities for tests that need to configure file-based checkpoints and
* savepoints, waits for checkpoint completion before creating savepoints Test job restart scenarios
* from savepoints. Subclasses are responsible for managing their own Flink MiniCluster lifecycle to
* enable full control over checkpoint/savepoint behavior.
*/
abstract class FlussVirtualTableITCaseBase {

/** Temporary directory for storing checkpoints during tests. */
@TempDir public static File checkpointDir;

/** Temporary directory for storing savepoints during tests. */
@TempDir public static File savepointDir;

/** Creates a Flink configuration with file-based checkpoints and savepoints. */
protected static Configuration getFileBasedCheckpointsConfig(File savepointDir) {
return getFileBasedCheckpointsConfig(savepointDir.toURI().toString());
}

/** Creates a Flink configuration with file-based checkpoints and savepoints. */
protected static Configuration getFileBasedCheckpointsConfig(final String savepointDir) {
final Configuration config = new Configuration();
config.set(StateBackendOptions.STATE_BACKEND, "hashmap");
config.set(CheckpointingOptions.CHECKPOINTS_DIRECTORY, checkpointDir.toURI().toString());
config.set(CheckpointingOptions.FS_SMALL_FILE_THRESHOLD, MemorySize.ZERO);
config.set(CheckpointingOptions.SAVEPOINT_DIRECTORY, savepointDir);
return config;
}

/**
* Waits for at least one checkpoint to complete for the given job. This method polls the
* checkpoint directory until a checkpoint subdirectory appears (prefixed with "chk-"). It is
* essential to call this before creating a savepoint to ensure the job has completed at least
* one checkpoint.
*/
protected static void waitForCheckpoint(JobID jobId) {
String jobIdStr = jobId.toHexString();
waitUntil(
() -> {
File jobCheckpointDir = new File(checkpointDir, jobIdStr);
if (!jobCheckpointDir.exists()) {
return false;
}
File[] checkpoints =
jobCheckpointDir.listFiles(
f -> f.isDirectory() && f.getName().startsWith("chk-"));
return checkpoints != null && checkpoints.length > 0;
},
Duration.ofSeconds(60),
"Timeout waiting for checkpoint for job " + jobIdStr);
}
}