org.apache.jackrabbit.oak.run.CheckCommand Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of oak-run Show documentation
There is a newer version: 1.72.0
/*
 * 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.jackrabbit.oak.run;

import java.io.File;
import java.io.IOException;
import java.io.PrintWriter;
import java.util.LinkedHashSet;
import java.util.Set;

import joptsimple.OptionParser;
import joptsimple.OptionSet;
import joptsimple.OptionSpec;
import org.apache.jackrabbit.oak.run.commons.Command;
import org.apache.jackrabbit.oak.segment.azure.tool.AzureCheck;
import org.apache.jackrabbit.oak.segment.tool.Check;

class CheckCommand implements Command {

    @Override
    public void execute(String... args) throws Exception {
        OptionParser parser = new OptionParser();
        OptionSpec mmapArg = parser.accepts("mmap", "use memory mapping for the file store (default: true)")
            .withOptionalArg()
            .ofType(Boolean.class)
            .defaultsTo(true);
        OptionSpec journal = parser.accepts("journal", "journal file")
            .withRequiredArg()
            .ofType(String.class);
        OptionSpec notify = parser.accepts("notify", "number of seconds between progress notifications")
            .withRequiredArg()
            .ofType(Long.class)
            .defaultsTo(Long.MAX_VALUE);
        OptionSpec last = parser.accepts("last", "define the number of revisions to be checked (default: 1)")
                .withOptionalArg()
                .ofType(Integer.class);
        OptionSpec bin = parser.accepts("bin", "read the content of binary properties");
        OptionSpec filter = parser.accepts("filter", "comma separated content paths to be checked")
            .withRequiredArg()
            .ofType(String.class)
            .withValuesSeparatedBy(',')
            .defaultsTo("/");
        OptionSpec head = parser.accepts("head", "checks only latest /root (i.e without checkpoints)");
        OptionSpec cp = parser.accepts("checkpoints", "checks only specified checkpoints (comma separated); use --checkpoints all to check all checkpoints")
            .withOptionalArg()
            .ofType(String.class)
            .withValuesSeparatedBy(',')
            .defaultsTo("all");
        OptionSpec ioStatistics = parser.accepts("io-stats", "Print I/O statistics (only for oak-segment-tar)");
        OptionSpec dir = parser.nonOptions()
            .describedAs("Path/URI to TAR/remote segment store (required)")
            .ofType(String.class);
        OptionSpec failFast = parser.accepts("fail-fast", "eagerly fail if first path/revision checked is inconsistent (default: false)")
                .withOptionalArg()
                .ofType(Boolean.class)
                .defaultsTo(false);
        OptionSpec persistentCachePath = parser.accepts("persistent-cache-path", "Path/URI to persistent cache where " +
                        "resulting segments will be written")
                .withRequiredArg()
                .ofType(String.class);
        OptionSpec persistentCacheSizeGb = parser.accepts("persistent-cache-size-gb", "Size in GB (defaults to 50 GB) for "
                        + "the persistent disk cache")
                .withRequiredArg()
                .ofType(Integer.class)
                .defaultsTo(50);
        OptionSet options = parser.parse(args);

        if (options.valuesOf(dir).isEmpty()) {
            printUsageAndExit(parser, "Segment Store path not specified");
        }

        if (options.valuesOf(dir).size() > 1) {
            printUsageAndExit(parser, "Too many Segment Store paths specified");
        }

        int code;
        if (options.valueOf(dir).startsWith("az:")) {
            AzureCheck.Builder builder = AzureCheck.builder()
                    .withPath(options.valueOf(dir))
                    .withDebugInterval(notify.value(options))
                    .withCheckBinaries(options.has(bin))
                    .withCheckHead(shouldCheckHead(options, head, cp))
                    .withCheckpoints(toCheckpointsSet(options, head, cp))
                    .withFilterPaths(toSet(options, filter))
                    .withIOStatistics(options.has(ioStatistics))
                    .withOutWriter(new PrintWriter(System.out, true))
                    .withErrWriter(new PrintWriter(System.err, true))
                    .withFailFast(failFast.value(options));

            if (options.has(last)) {
                builder.withRevisionsCount(options.valueOf(last) != null ? last.value(options) : 1);
            }

            if (options.has(persistentCachePath)) {
                builder.withPersistentCachePath(persistentCachePath.value(options));
                builder.withPersistentCacheSizeGb(persistentCacheSizeGb.value(options));
            }

            code = builder.build().run();
        } else {
            Check.Builder builder = Check.builder()
                    .withPath(new File(options.valueOf(dir)))
                    .withMmap(mmapArg.value(options))
                    .withDebugInterval(notify.value(options))
                    .withCheckBinaries(options.has(bin))
                    .withCheckHead(shouldCheckHead(options, head, cp))
                    .withCheckpoints(toCheckpointsSet(options, head, cp))
                    .withFilterPaths(toSet(options, filter))
                    .withIOStatistics(options.has(ioStatistics))
                    .withOutWriter(new PrintWriter(System.out, true))
                    .withErrWriter(new PrintWriter(System.err, true))
                    .withFailFast(failFast.value(options));

            if (options.has(journal)) {
                builder.withJournal(new File(journal.value(options)));
            }

            if (options.has(last)) {
                builder.withRevisionsCount(options.valueOf(last) != null ? last.value(options) : 1);
            }

            code = builder.build().run();
        }

        System.exit(code);
    }

    private void printUsageAndExit(OptionParser parser, String... messages) throws IOException {
        for (String message : messages) {
            System.err.println(message);
        }
        System.err.println("usage: check path/to/segmentstore ");
        parser.printHelpOn(System.err);
        System.exit(1);
    }

    private static Set toSet(OptionSet options, OptionSpec option) {
        return new LinkedHashSet<>(option.values(options));
    }

    private static Set toCheckpointsSet(OptionSet options, OptionSpec head, OptionSpec cp) {
        Set checkpoints = new LinkedHashSet<>();
        if (options.has(cp) || !options.has(head)) {
            checkpoints.addAll(cp.values(options));
        }
        return checkpoints;
    }

    private static boolean shouldCheckHead(OptionSet options, OptionSpec head, OptionSpec cp) {
        return !options.has(cp) || options.has(head);
    }

}