Skip to content

Commit

Permalink
Server admin tool: add command to purge unreferenced Objs
Browse files Browse the repository at this point in the history
Adds a new command to access the implementation provided by projectnessie#9688
  • Loading branch information
snazy committed Oct 15, 2024
1 parent ea06b0e commit ad9bb6d
Show file tree
Hide file tree
Showing 7 changed files with 369 additions and 1 deletion.
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,9 @@ as necessary. Empty sections will not end in the release notes.

### New Features

- Add functionality to the Nessie server admin tool, the `cleanup-repository` command, to delete
unneeded objects from a Nessie repository (backend database).

### Changes

- The persistence cache tries to avoid deserialization overhead when getting an object from the
Expand Down
4 changes: 4 additions & 0 deletions site/in-dev/export_import.md
Original file line number Diff line number Diff line change
Expand Up @@ -223,6 +223,10 @@ Below is the output of the Nessie Server Admin tool help for all commands.

{% include './generated-docs/serverAdmin-help-delete-catalog-tasks.md' %}

### `cleanup-repository`

{% include './generated-docs/serverAdmin-help-cleanup-repository.md' %}

### `erase-repository`

{% include './generated-docs/serverAdmin-help-erase-repository.md' %}
Expand Down
1 change: 1 addition & 0 deletions tools/doc-generator/site-gen/build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -242,6 +242,7 @@ val serverAdminHelp by tasks.registering(JavaExec::class) {
"info",
"check-content",
"delete-catalog-tasks",
"cleanup-repository",
"erase-repository",
"export",
"import",
Expand Down
3 changes: 2 additions & 1 deletion tools/server-admin/build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ dependencies {
implementation(project(":nessie-versioned-storage-cache"))
implementation(project(":nessie-versioned-storage-cassandra"))
implementation(project(":nessie-versioned-storage-cassandra2"))
implementation(project(":nessie-versioned-storage-cleanup"))
implementation(project(":nessie-versioned-storage-common"))
implementation(project(":nessie-versioned-storage-dynamodb"))
implementation(project(":nessie-versioned-storage-dynamodb2"))
Expand Down Expand Up @@ -187,7 +188,7 @@ if (Os.isFamily(Os.FAMILY_MAC) && System.getenv("CI") != null) {
tasks.named<Test>("intTest").configure {
// Reduce likelihood of OOM due to too many Quarkus apps in memory;
// Ideally, set this number to the number of IT classes to run for each backend.
forkEvery = 5
forkEvery = 6
// Optional; comma-separated list of backend names to test against;
// see NessieServerAdminTestBackends for valid values.
systemProperty("backends", System.getProperty("backends"))
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,96 @@
/*
* Copyright (C) 2024 Dremio
*
* Licensed 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.projectnessie.tools.admin.cli;

import io.quarkus.test.junit.TestProfile;
import io.quarkus.test.junit.main.QuarkusMainLauncher;
import io.quarkus.test.junit.main.QuarkusMainTest;
import org.assertj.core.api.SoftAssertions;
import org.assertj.core.api.junit.jupiter.InjectSoftAssertions;
import org.assertj.core.api.junit.jupiter.SoftAssertionsExtension;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
import org.projectnessie.quarkus.tests.profiles.BaseConfigProfile;
import org.projectnessie.versioned.storage.common.persist.Persist;

@QuarkusMainTest
@TestProfile(BaseConfigProfile.class)
@ExtendWith({NessieServerAdminTestExtension.class, SoftAssertionsExtension.class})
class ITCleanupRepository extends AbstractContentTests<Object> {

@InjectSoftAssertions private SoftAssertions soft;

ITCleanupRepository(Persist persist) {
super(persist, Object.class);
}

@Test
public void testCleanup(QuarkusMainLauncher launcher) {
var launchResult = launcher.launch("cleanup-repository");
soft.assertThat(launchResult.exitCode()).isEqualTo(0);
soft.assertThat(launchResult.getOutputStream())
.contains(
"Identifying referenced objects, processing unlimited commits per second, processing unlimited objects per second, expecting max 1000000 objects, estimated context heap pressure: 18.396 M")
.anyMatch(
s ->
s.matches(
"Finished identifying referenced objects after PT.*. Processed 3 references, 3 commits, 2 objects, 0 contents."))
.anyMatch(
s ->
s.matches(
"Purging unreferenced objects, referenced before .*, scanning unlimited objects per second, deleting unlimited objects per second, estimated context heap pressure: 5.713 M"))
.anyMatch(
s ->
s.matches(
"Finished purging unreferenced objects after PT.*. Scanned 5 objects, 0 were deleted."));
}

@Test
public void testCleanupParams(QuarkusMainLauncher launcher) {
var launchResult =
launcher.launch(
"cleanup-repository",
CleanupRepository.DRY_RUN,
CleanupRepository.COMMIT_RATE,
"11",
CleanupRepository.OBJ_RATE,
"12",
CleanupRepository.SCAN_OBJ_RATE,
"13",
CleanupRepository.PURGE_OBJ_RATE,
"14",
CleanupRepository.REFERENCED_GRACE,
"P10D",
CleanupRepository.OBJ_COUNT,
"1000");
soft.assertThat(launchResult.exitCode()).isEqualTo(0);
soft.assertThat(launchResult.getOutputStream())
.contains(
"Identifying referenced objects, processing 11 commits per second, processing 12 objects per second, expecting max 1000 objects, estimated context heap pressure: 12.688 M")
.anyMatch(
s ->
s.matches(
"Finished identifying referenced objects after PT.*. Processed 3 references, 3 commits, 2 objects, 0 contents."))
.anyMatch(
s ->
s.matches(
"Dry-run cleanup unreferenced objects, referenced before .*, scanning 13 objects per second, deleting 14 objects per second, estimated context heap pressure: 0.006 M"))
.anyMatch(
s ->
s.matches(
"Finished purging unreferenced objects after PT.*. Scanned 5 objects, 0 were deleted."));
}
}
Loading

0 comments on commit ad9bb6d

Please sign in to comment.