IGNITE-27033: Сheckpoint command added by DEADripER · Pull Request #12547 · apache/ignite

DEADripER · 2025-12-01T16:43:42Z

Thank you for submitting the pull request to the Apache Ignite.

In order to streamline the review of the contribution
we ask you to ensure the following steps have been taken:

The Contribution Checklist

There is a single JIRA ticket related to the pull request.
The web-link to the pull request is attached to the JIRA ticket.
The JIRA ticket has the Patch Available state.
The pull request body describes changes that have been made.
The description explains WHAT and WHY was made instead of HOW.
The pull request title is treated as the final commit message.
The following pattern must be used: IGNITE-XXXX Change summary where XXXX - number of JIRA issue.
A reviewer has been mentioned through the JIRA comments
(see the Maintainers list)
The pull request has been checked by the Teamcity Bot and
the green visa attached to the JIRA ticket (see TC.Bot: Check PR)

Notes

If you need any help, please email dev@ignite.apache.org or ask anу advice on http://asf.slack.com #ignite channel.

ac1d0globlya · 2025-12-02T08:34:07Z

+import org.apache.ignite.internal.management.api.ComputeCommand;
+import org.jetbrains.annotations.Nullable;
+
+public class CheckpointForceCommand implements ComputeCommand<CheckpointForceCommandArg, String> {


This logic must be in CheckpointCommand itself.

So the desired syntax is:

> ./control.sh --checkpoint > ./control.sh --checkpoint --reason "After data load checkpoint" > ./control.sh --checkoint --wait-for-finish --timeout 60000

ac1d0globlya · 2025-12-02T08:39:57Z

+        }
+
+        /** {@inheritDoc} */
+        @Override protected String run(@Nullable CheckpointForceCommandArg arg) throws IgniteException {


We must check if persistence enabled on node with the:

if (!CU.isPersistenceEnabled(ignite.configuration())) { throw new IgniteException("Can't checkpoint on in-memory node"); // Or return some result here. }

nizhikov · 2025-12-03T07:56:35Z

@DEADripER please, fix code style violations.

nizhikov · 2025-12-04T08:35:46Z

+import org.apache.ignite.internal.management.api.ComputeCommand;
+import org.jetbrains.annotations.Nullable;
+
+/** Checkpoint command class*/


typo: /** Checkpoint command class*/ -> /** Checkpoint command. */

nizhikov · 2025-12-04T08:43:45Z

+                CheckpointProgress checkpointfut = dbMgr.forceCheckpoint(reason);
+
+                if (waitForFinish) {
+                    if (timeout != null && timeout > 0) {


if (timeout != null && timeout > 0) checkpointfut.futureFor(CheckpointState.FINISHED).get(timeout, TimeUnit.MILLISECONDS); else checkpointfut.futureFor(CheckpointState.FINISHED).get();

nizhikov · 2025-12-04T08:44:26Z

+                    }
+                    return "Checkpoint completed on node: " + ignite.localNode().id();
+                }
+                else {


else return "Checkpoint triggered on node: " + ignite.localNode().id();

nizhikov · 2025-12-04T08:46:02Z

+
+        /** {@inheritDoc} */
+        @Override protected String run(@Nullable CheckpointCommandArg arg) throws IgniteException {
+            if (!CU.isPersistenceEnabled(ignite.configuration())) {


One line statements written without quote.
Please, take a look at style guide:

https://cwiki.apache.org/confluence/display/IGNITE/Coding+Guidelines

if (!CU.isPersistenceEnabled(ignite.configuration())) throw new IgniteException("Can't checkpoint on in-memory node");

nizhikov · 2025-12-04T08:50:44Z

+                throw new IgniteException("Can't checkpoint on in-memory node");
+            }
+
+            String reason = arg != null && arg.reason() != null ? arg.reason() : "control.sh";


Let's skip arg null checks here and in other places.

nizhikov · 2025-12-04T08:51:05Z

+        }
+
+        /** {@inheritDoc} */
+        @Override protected String run(@Nullable CheckpointCommandArg arg) throws IgniteException {


Please, remove Nullable annotation.

nizhikov · 2025-12-04T08:53:02Z

+        stopAllGrids();
+        cleanPersistenceDir();
+        injectTestSystemOut();
+        super.beforeTest();


super.beforeTest(); must be invoked first.

nizhikov · 2025-12-04T08:54:41Z

+    @Override protected IgniteConfiguration getConfiguration(String igniteInstanceName) throws Exception {
+        IgniteConfiguration cfg = super.getConfiguration(igniteInstanceName);
+
+        if (clusterState == 1)


Let's use
GridCommandHandlerAbstractTest#persistenceEnable instead of clusterState flag

wernerdv · 2025-12-11T09:47:22Z

+
+import java.util.Objects;
+import java.util.regex.Pattern;
+


Remove the empty line.

wernerdv · 2025-12-11T09:54:19Z

+/** Test for checkpoint in control.sh command. */
+public class GridCommandHandlerCheckpointTest extends GridCommandHandlerAbstractTest {
+    /** */
+    protected final ListeningTestLogger listeningLog = new ListeningTestLogger(log);


wernerdv · 2025-12-11T10:14:58Z

+        IgniteEx srv = startGrids(2);
+        IgniteEx cli = startClientGrid("client");
+
+        LogListener checkpointFinishedLsnr = LogListener.matches("Checkpoint finished").build();


To avoid duplication of creating checkpointFinishedLsnr in each test, let's create a field and reuse it across all tests:

/** */ private final ListeningTestLogger listeningLog = new ListeningTestLogger(log); /** */ private final LogListener checkpointFinishedLsnr = LogListener.matches("Checkpoint finished").build(); /** */ @Override protected IgniteConfiguration getConfiguration(String igniteInstanceName) throws Exception { IgniteConfiguration cfg = super.getConfiguration(igniteInstanceName); if (!persistenceEnable()) cfg.setDataStorageConfiguration(null); listeningLog.registerListener(checkpointFinishedLsnr); cfg.setGridLogger(listeningLog); return cfg; }

wernerdv · 2025-12-11T10:38:38Z

+        srv.createCache("testCache");
+        assertEquals(EXIT_CODE_UNEXPECTED_ERROR, execute("--checkpoint"));
+
+        String out = testOut.toString();


Let's move it after the line outputContains(...).

wernerdv · 2025-12-11T11:15:52Z

+    }
+
+    /** {@inheritDoc} */
+    @Override public @Nullable Collection<ClusterNode> nodes(


Let's place on a single line.
@Override public @Nullable Collection<ClusterNode> nodes(Collection<ClusterNode> nodes, CheckpointCommandArg arg) {

wernerdv · 2025-12-11T11:24:05Z

+
+    /** */
+    @Argument(description = "Timeout in milliseconds", optional = true)
+    private Long timeout;


Maybe we could use a primitive type?
private long timeout = -1;

wernerdv · 2025-12-11T11:38:26Z

+        }
+
+        /** {@inheritDoc} */
+        @Override protected String run(CheckpointCommandArg arg) throws IgniteException {


I suggest refactoring slightly to make the code easier to read:

/** {@inheritDoc} */ @Override protected String run(CheckpointCommandArg arg) throws IgniteException { if (!CU.isPersistenceEnabled(ignite.configuration())) throw new IgniteException("Can't checkpoint on in-memory node"); try { GridCacheDatabaseSharedManager dbMgr = (GridCacheDatabaseSharedManager)ignite.context().cache().context().database(); CheckpointProgress checkpointfut = dbMgr.forceCheckpoint(arg.reason()); if (!arg.waitForFinish()) return "Checkpoint triggered on node: " + ignite.localNode().id(); long timeout = arg.timeout(); if (timeout > 0) checkpointfut.futureFor(CheckpointState.FINISHED).get(timeout, TimeUnit.MILLISECONDS); else checkpointfut.futureFor(CheckpointState.FINISHED).get(); return "Checkpoint completed on node: " + ignite.localNode().id(); } catch (Exception e) { throw new IgniteException("Failed to force checkpoint on node: " + ignite.localNode().id(), e); } }

+, thank you for refactoring

wernerdv · 2025-12-11T19:18:48Z

+    @Override protected void writeExternalData(ObjectOutput out) throws IOException {
+        U.writeString(out, reason);
+        out.writeBoolean(waitForFinish);
+        out.writeObject(timeout);


out.writeLong

ac1d0globlya · 2025-12-26T08:08:29Z

+        cacheCli.put(1, 1);
+
+        assertEquals(EXIT_CODE_OK, execute("--checkpoint"));
+


no new line

ac1d0globlya · 2025-12-26T08:08:34Z

+        assertEquals(EXIT_CODE_OK, execute("--checkpoint"));
+
+        assertTrue(GridTestUtils.waitForCondition(checkpointFinishedLsnr::check, 10_000));
+


no new line

ac1d0globlya · 2025-12-26T08:08:41Z

+
+        assertTrue(GridTestUtils.waitForCondition(checkpointFinishedLsnr::check, 10_000));
+
+        assertFalse(testOut.toString().contains("PDS disabled"));


new line after

ac1d0globlya · 2025-12-26T08:08:47Z

+        assertFalse(testOut.toString().contains("PDS disabled"));
+        outputContains(": Checkpoint started");
+
+        testOut.reset();


new line after

ac1d0globlya · 2025-12-26T08:10:31Z

+        startClientGrid("client");
+        srv.cluster().state(ClusterState.ACTIVE);
+
+        srv.createCache("testCache");


new line after

ac1d0globlya · 2025-12-26T08:10:37Z

+
+        srv.createCache("testCache");
+        assertEquals(EXIT_CODE_OK, execute("--checkpoint"));
+


no new line

ac1d0globlya · 2025-12-26T08:10:45Z

+    public void testCheckpointTimeout() throws Exception {
+        persistenceEnable(true);
+
+        IgniteEx srv = startGrids(1);


new line after

ac1d0globlya · 2025-12-26T08:10:51Z

+    public void testMixedCluster() throws Exception {
+        mixedConfig = true;
+
+        IgniteEx node0 = startGrid("in-memory_instance");


new line after

ac1d0globlya · 2025-12-26T08:11:04Z

+        DataRegionConfiguration[] node1Regions = node1Storage.getDataRegionConfigurations();
+        assertEquals(1, node1Regions.length);
+
+        DataRegionConfiguration persistentRegion = node1Regions[0];


new line after

ac1d0globlya · 2025-12-26T08:11:10Z

+
+        assertEquals(EXIT_CODE_OK, execute("--checkpoint", "--wait-for-finish"));
+
+        assertTrue(checkpointFinishedLsnr.check());


new line after

ac1d0globlya · 2025-12-26T11:29:40Z

+
+        if (mixedConfig) {
+            DataStorageConfiguration storageCfg = new DataStorageConfiguration();
+            DataRegionConfiguration dfltRegionCfg = new DataRegionConfiguration();


Single usage.
Let's inline dfltDataRegion:

storageCfg.setDefaultDataRegionConfiguration(new DataRegionConfiguration().setName("default_in_memory_region").setPersistenceEnabled(false));

nizhikov · 2025-12-26T12:08:37Z

+    private final LogListener checkpointFinishedLsnr = LogListener.matches("Checkpoint finished").build();
+
+    /** */
+    private boolean mixedConfig = false;


useless initialization. Default value false, already.

nizhikov · 2025-12-26T12:09:19Z

+    private boolean mixedConfig = false;
+
+    /** */
+    private static final String persistentRegionName = "pds-reg";


constants must be in UPPER_CASE.
Please, move constant to the top of class.

nizhikov · 2025-12-29T10:45:35Z

+        IgniteCache<Integer, Integer> cacheCli = cli.getOrCreateCache(DEFAULT_CACHE_NAME);
+
+        cacheSrv.put(1, 1);
+        cacheCli.put(1, 1);


It's enough to put from single cache instance, only.
Please, remove cacheSrv.put here and below.

sonarqubecloud · 2025-12-30T12:02:39Z

Quality Gate passed

Issues
1 New issue
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

alex-plekhanov · 2025-12-30T14:20:58Z

+            DataStorageConfiguration storageCfg = new DataStorageConfiguration();
+
+            storageCfg.setDefaultDataRegionConfiguration(new DataRegionConfiguration().setName("default_in_memory_region")
+                                                                                      .setPersistenceEnabled(false));


Please use correct indent (4 spaces) next time

alex-plekhanov · 2025-12-30T14:22:49Z

+        else if (!persistenceEnable()) {
+            cfg.setDataStorageConfiguration(null);
+        }


Also, we don't use braces for one-line "if" statements, see Ignite codestyle

IGNITE-27033: checkpoint control.sh command

a9ff431

ac1d0globlya reviewed Dec 2, 2025

View reviewed changes

fix --checkpoint [params] and check for persistence

b641670

DEADripER added 5 commits December 3, 2025 16:04

checkstyle

3b587c8

checkstyle 2

67f7e21

add new tests

42fe06e

* fix

5743032

* fix 2

936dce1

nizhikov reviewed Dec 4, 2025

View reviewed changes

DEADripER added 3 commits December 8, 2025 10:47

log listener

d51ada4

not working test

ecfbe60

fix test

ccf2aca

wernerdv reviewed Dec 11, 2025

View reviewed changes

review fixes

4b5b778

wernerdv reviewed Dec 11, 2025

View reviewed changes

ac1d0globlya reviewed Dec 26, 2025

View reviewed changes

DEADripER added 2 commits December 26, 2025 13:43

newlines and nibor fixes

a814c94

fix

e93f9fb

ac1d0globlya reviewed Dec 26, 2025

View reviewed changes

nizhikov reviewed Dec 26, 2025

View reviewed changes

DEADripER added 2 commits December 26, 2025 20:37

fix 2

7cc73a1

fix line length

bfa8d17

nizhikov approved these changes Dec 29, 2025

View reviewed changes

formatting

95f42b5

nizhikov reviewed Dec 29, 2025

View reviewed changes

DEADripER added 4 commits December 29, 2025 15:57

remove server cache

0c7a20f

checkpoint timeout

7bfd7f4

formatting

4b8e534

formatting 2

cdaddb8

nizhikov changed the title ~~IGNITE-27033: checkpoint control.sh command~~ IGNITE-27033: Сheckpoint command added Dec 30, 2025

nizhikov approved these changes Dec 30, 2025

View reviewed changes

nizhikov merged commit 93394ab into apache:master Dec 30, 2025
9 checks passed

alex-plekhanov reviewed Dec 30, 2025

View reviewed changes

		cacheCli.put(1, 1);

		assertEquals(EXIT_CODE_OK, execute("--checkpoint"));

		assertEquals(EXIT_CODE_OK, execute("--checkpoint"));

		assertTrue(GridTestUtils.waitForCondition(checkpointFinishedLsnr::check, 10_000));


		assertTrue(GridTestUtils.waitForCondition(checkpointFinishedLsnr::check, 10_000));

		assertFalse(testOut.toString().contains("PDS disabled"));


		srv.createCache("testCache");
		assertEquals(EXIT_CODE_OK, execute("--checkpoint"));


		assertEquals(EXIT_CODE_OK, execute("--checkpoint", "--wait-for-finish"));

		assertTrue(checkpointFinishedLsnr.check());


		import java.util.Objects;
		import java.util.regex.Pattern;

Conversation

DEADripER commented Dec 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

The Contribution Checklist

Notes

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

nizhikov commented Dec 3, 2025

Uh oh!

nizhikov Dec 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

nizhikov Dec 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

wernerdv Dec 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

DEADripER Dec 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

DEADripER Dec 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

DEADripER Dec 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

DEADripER commented Dec 1, 2025 •

edited

Loading

nizhikov Dec 4, 2025 •

edited

Loading

nizhikov Dec 4, 2025 •

edited

Loading

wernerdv Dec 11, 2025 •

edited

Loading

DEADripER Dec 11, 2025 •

edited

Loading

DEADripER Dec 11, 2025 •

edited

Loading

DEADripER Dec 11, 2025 •

edited

Loading