/*
 * 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.plugins.document;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.concurrent.TimeUnit;

import org.apache.jackrabbit.oak.plugins.document.util.MongoConnection;
import org.apache.jackrabbit.oak.run.RevisionsCommand;
import org.junit.Before;
import org.junit.BeforeClass;
import org.junit.Rule;
import org.junit.Test;

import static org.apache.jackrabbit.oak.plugins.document.CommandTestUtils.captureSystemErr;
import static org.apache.jackrabbit.oak.plugins.document.CommandTestUtils.captureSystemOut;
import static org.apache.jackrabbit.oak.plugins.document.VersionGarbageCollector.SETTINGS_COLLECTION_FULL_GC_DOCUMENT_ID_PROP;
import static org.apache.jackrabbit.oak.plugins.document.VersionGarbageCollector.SETTINGS_COLLECTION_FULL_GC_DRY_RUN_DOCUMENT_ID_PROP;
import static org.apache.jackrabbit.oak.plugins.document.VersionGarbageCollector.SETTINGS_COLLECTION_FULL_GC_DRY_RUN_TIMESTAMP_PROP;
import static org.apache.jackrabbit.oak.plugins.document.VersionGarbageCollector.SETTINGS_COLLECTION_FULL_GC_TIMESTAMP_PROP;
import static org.apache.jackrabbit.oak.plugins.document.VersionGarbageCollector.SETTINGS_COLLECTION_ID;
import static org.apache.jackrabbit.oak.plugins.document.util.Utils.getIdFromPath;
import static org.hamcrest.CoreMatchers.containsString;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertNull;
import static org.hamcrest.MatcherAssert.assertThat;
import static org.junit.Assert.assertTrue;
import static org.junit.Assume.assumeTrue;

public class RevisionsCommandTest {

    @Rule
    public MongoConnectionFactory connectionFactory = new MongoConnectionFactory();

    @Rule
    public DocumentMKBuilderProvider builderProvider = new DocumentMKBuilderProvider();

    private DocumentNodeStore ns;

    @BeforeClass
    public static void assumeMongoDB() {
        assumeTrue(MongoUtils.isAvailable());
    }

    @Before
    public void before() {
        ns = createDocumentNodeStore();
    }

    @Test
    public void info() throws Exception {
        ns.getVersionGarbageCollector().gc(1, TimeUnit.HOURS);
        ns.dispose();

        String output = captureSystemOut(new RevisionsCmd("info"));
        assertTrue(output.contains("Last Successful Run"));
    }

    @Test
    public void reset() throws Exception {
        ns.getVersionGarbageCollector().gc(1, TimeUnit.HOURS);

        Document doc = ns.getDocumentStore().find(Collection.SETTINGS, SETTINGS_COLLECTION_ID);
        assertNotNull(doc);

        ns.dispose();

        String output = captureSystemOut(new RevisionsCmd("reset"));
        assertTrue(output.contains("resetting recommendations and statistics"));

        MongoConnection c = connectionFactory.getConnection();
        assertNotNull(c);
        ns = builderProvider.newBuilder()
                .setMongoDB(c.getMongoClient(), c.getDBName()).getNodeStore();
        doc = ns.getDocumentStore().find(Collection.SETTINGS, SETTINGS_COLLECTION_ID);
        assertNull(doc);
    }

    @Test
    public void resetFullGC() throws Exception {
        // need to set fullGCEnabled to true, so let's bounce the default one
        ns.dispose();
        // and create it fresh with fullGCEnabled==true
        ns = createDocumentNodeStore(true);
        ns.getVersionGarbageCollector().gc(1, TimeUnit.HOURS);

        Document doc = ns.getDocumentStore().find(Collection.SETTINGS, SETTINGS_COLLECTION_ID);
        assertNotNull(doc);
        assertNotNull(doc.get(SETTINGS_COLLECTION_FULL_GC_TIMESTAMP_PROP));
        assertNotNull(doc.get(SETTINGS_COLLECTION_FULL_GC_DOCUMENT_ID_PROP));

        ns.dispose();

        String output = captureSystemOut(new RevisionsCmd("reset", "--fullGCOnly"));
        assertTrue(output.contains("resetting recommendations and statistics"));

        MongoConnection c = connectionFactory.getConnection();
        assertNotNull(c);
        ns = builderProvider.newBuilder()
                .setMongoDB(c.getMongoClient(), c.getDBName()).getNodeStore();
        doc = ns.getDocumentStore().find(Collection.SETTINGS, SETTINGS_COLLECTION_ID);
        assertNotNull(doc);
        assertNull(doc.get(SETTINGS_COLLECTION_FULL_GC_TIMESTAMP_PROP));
        assertNull(doc.get(SETTINGS_COLLECTION_FULL_GC_DOCUMENT_ID_PROP));
    }

    @Test
    public void resetFullGCWithFullGC() throws Exception {
        // need to set fullGCEnabled to true, so let's bounce the default one
        ns.dispose();
        // and create it fresh with fullGCEnabled==true
        ns = createDocumentNodeStore(true);
        ns.getVersionGarbageCollector().gc(1, TimeUnit.HOURS);

        Document doc = ns.getDocumentStore().find(Collection.SETTINGS, SETTINGS_COLLECTION_ID);
        assertNotNull(doc);
        assertNotNull(doc.get(SETTINGS_COLLECTION_FULL_GC_TIMESTAMP_PROP));
        assertNotNull(doc.get(SETTINGS_COLLECTION_FULL_GC_DOCUMENT_ID_PROP));

        ns.dispose();

        String output = captureSystemOut(new RevisionsCmd("fullGC", "--resetFullGC", "true", "--entireRepo"));
        assertTrue(output.contains("ResetFullGC is enabled : true"));

        MongoConnection c = connectionFactory.getConnection();
        assertNotNull(c);
        ns = builderProvider.newBuilder().setMongoDB(c.getMongoClient(), c.getDBName()).getNodeStore();
        doc = ns.getDocumentStore().find(Collection.SETTINGS, SETTINGS_COLLECTION_ID);
        assertNotNull(doc);
        assertNull(doc.get(SETTINGS_COLLECTION_FULL_GC_TIMESTAMP_PROP));
        assertNull(doc.get(SETTINGS_COLLECTION_FULL_GC_DOCUMENT_ID_PROP));
    }

    @Test
    public void resetDryRunFields() throws Exception {
        // need to set fullGCEnabled to true, so let's bounce the default one
        ns.dispose();
        // and create it fresh with fullGCEnabled==true
        ns = createDocumentNodeStore(true);
        ns.getVersionGarbageCollector().gc(1, TimeUnit.HOURS);

        Document doc = ns.getDocumentStore().find(Collection.SETTINGS, SETTINGS_COLLECTION_ID);
        assertNotNull(doc);
        assertNull(doc.get(SETTINGS_COLLECTION_FULL_GC_DRY_RUN_TIMESTAMP_PROP));
        assertNull(doc.get(SETTINGS_COLLECTION_FULL_GC_DRY_RUN_DOCUMENT_ID_PROP));

        ns.dispose();

        String output = captureSystemOut(new RevisionsCmd("fullGC", "--entireRepo"));
        assertTrue(output.contains("DryRun is enabled : true"));

        MongoConnection c = connectionFactory.getConnection();
        assertNotNull(c);
        ns = builderProvider.newBuilder()
                .setMongoDB(c.getMongoClient(), c.getDBName()).getNodeStore();
        doc = ns.getDocumentStore().find(Collection.SETTINGS, SETTINGS_COLLECTION_ID);
        assertNotNull(doc);
        assertNull(doc.get(SETTINGS_COLLECTION_FULL_GC_DRY_RUN_TIMESTAMP_PROP));
        assertNull(doc.get(SETTINGS_COLLECTION_FULL_GC_DRY_RUN_DOCUMENT_ID_PROP));
    }

    @Test
    public void collect() {
        ns.dispose();

        String output = captureSystemOut(new RevisionsCmd("collect"));
        assertTrue(output.contains("starting gc collect"));
    }

    @Test
    public void fullGC() {
        ns.dispose();

        String output = captureSystemOut(new RevisionsCmd("fullGC", "--entireRepo"));
        assertTrue(output.contains("DryRun is enabled : true\n"));
        assertTrue(output.contains("ResetFullGC is enabled : false\n"));
        assertTrue(output.contains("Compaction is enabled : false\n"));
        assertTrue(output.contains("starting gc collect\n"));
        assertTrue(output.contains("IncludePaths are : []\n"));
        assertTrue(output.contains("ExcludePaths are : []\n"));
        assertTrue(output.contains("FullGcMode is : NONE\n"));
        assertTrue(output.contains("FullGcDelayFactor is : 2.0\n"));
        assertTrue(output.contains("FullGcBatchSize is : 1000\n"));
        assertTrue(output.contains("FullGcProgressSize is : 10000\n"));
        assertTrue(output.contains("FullGcMaxAgeInSecs is : 86400\n"));
        assertTrue(output.contains("FullGcMaxAgeMillis is : 86400000\n"));
        assertTrue(output.contains("FullGCGeneration is : 0\n"));
    }

    @Test
    public void fullGCWithMaxAgeInSecs() {
        ns.dispose();

        String output = captureSystemOut(new RevisionsCmd("fullGC", "--fullGcMaxAge", "10000", "--entireRepo"));
        assertTrue(output.contains("FullGcMaxAgeInSecs is : 10000\n"));
        assertTrue(output.contains("FullGcMaxAgeMillis is : 10000000\n"));
        assertTrue(output.contains("starting gc collect"));
    }

    @Test
    public void fullGCWithDelayFactor() {
        ns.dispose();

        String output = captureSystemOut(new RevisionsCmd("fullGC", "--fullGcDelayFactor", "2.5", "--entireRepo"));
        assertTrue(output.contains("FullGcDelayFactor is : 2.5\n"));
        assertTrue(output.contains("starting gc collect"));
    }

    @Test
    public void fullGCWithBatchSize() {
        ns.dispose();

        String output = captureSystemOut(new RevisionsCmd("fullGC", "--fullGcBatchSize", "200", "--entireRepo"));
        assertTrue(output.contains("FullGcBatchSize is : 200\n"));
        assertTrue(output.contains("starting gc collect"));
    }

    @Test
    public void fullGCWithProgressSize() {
        ns.dispose();

        String output = captureSystemOut(new RevisionsCmd("fullGC", "--fullGcProgressSize", "20000", "--entireRepo"));
        assertTrue(output.contains("FullGcProgressSize is : 20000\n"));
        assertTrue(output.contains("starting gc collect"));
    }

    @Test
    public void fullGCWithMode() {
        ns.dispose();

        String output = captureSystemOut(new RevisionsCmd("fullGC", "--entireRepo", "--fullGcMode", "3"));
        assertTrue(output.contains("DryRun is enabled : true"));
        assertTrue(output.contains("ResetFullGC is enabled : false"));
        assertTrue(output.contains("Compaction is enabled : false"));
        assertTrue(output.contains("starting gc collect"));
        assertTrue(output.contains("FullGcMode is : GAP_ORPHANS_EMPTYPROPS"));
    }

    @Test
    public void fullGCWithModeAllOrphans() {
        ns.dispose();

        String output = captureSystemOut(new RevisionsCmd("fullGC", "--entireRepo", "--fullGcMode", "4"));
        assertTrue(output.contains("DryRun is enabled : true"));
        assertTrue(output.contains("ResetFullGC is enabled : false"));
        assertTrue(output.contains("Compaction is enabled : false"));
        assertTrue(output.contains("starting gc collect"));
        assertTrue(output.contains("FullGcMode is : ALL_ORPHANS_EMPTYPROPS"));
    }

    @Test
    public void fullGCWithIncludePaths() {
        ns.dispose();

        String output = captureSystemOut(new RevisionsCmd("fullGC", "--entireRepo", "--includePaths", "/content::/var"));
        assertTrue(output.contains("DryRun is enabled : true"));
        assertTrue(output.contains("ResetFullGC is enabled : false"));
        assertTrue(output.contains("Compaction is enabled : false"));
        assertTrue(output.contains("starting gc collect"));
        assertTrue(output.contains("IncludePaths are : [/content, /var]"));
    }

    @Test
    public void fullGCWithExcludePaths() {
        ns.dispose();

        String output = captureSystemOut(new RevisionsCmd("fullGC", "--entireRepo", "--excludePaths", "/content::/var"));
        assertTrue(output.contains("DryRun is enabled : true"));
        assertTrue(output.contains("ResetFullGC is enabled : false"));
        assertTrue(output.contains("Compaction is enabled : false"));
        assertTrue(output.contains("starting gc collect"));
        assertTrue(output.contains("ExcludePaths are : [/content, /var]"));
    }

    @Test
    public void fullGCWithCompaction() {
        ns.dispose();

        String output = captureSystemOut(new RevisionsCmd("fullGC", "--entireRepo", "--compact"));
        assertTrue(output.contains("DryRun is enabled : true"));
        assertTrue(output.contains("ResetFullGC is enabled : false"));
        assertTrue(output.contains("Compaction is enabled : true"));
        assertTrue(output.contains("starting gc collect"));
    }

    @Test
    public void fullGCWithoutDryRun() {
        ns.dispose();

        String output = captureSystemOut(new RevisionsCmd("fullGC", "--dryRun", "false", "--entireRepo"));
        assertTrue(output.contains("DryRun is enabled : false"));
        assertTrue(output.contains("starting gc collect"));
    }

    @Test
    public void fullGCWithDryRun() {
        ns.dispose();

        String output = captureSystemOut(new RevisionsCmd("fullGC", "--dryRun", "true", "--entireRepo"));
        assertTrue(output.contains("DryRun is enabled : true"));
        assertTrue(output.contains("starting gc collect"));
    }

    @Test
    public void fullGCWithoutResetFullGC() {
        ns.dispose();

        String output = captureSystemOut(new RevisionsCmd("fullGC", "--resetFullGC", "false", "--entireRepo"));
        assertTrue(output.contains("ResetFullGC is enabled : false"));
        assertTrue(output.contains("starting gc collect"));
    }

    @Test
    public void fullGCWithResetFullGC() {
        ns.dispose();

        String output = captureSystemOut(new RevisionsCmd("fullGC", "--resetFullGC", "true", "--entireRepo"));
        assertTrue(output.contains("ResetFullGC is enabled : true"));
        assertTrue(output.contains("starting gc collect"));
    }

    @Test
    public void fullGCWithoutFullGCGeneration() {
        ns.dispose();

        String output = captureSystemOut(new RevisionsCmd("fullGC", "--entireRepo"));
        assertTrue(output.contains("FullGCGeneration is : 0"));
        assertTrue(output.contains("starting gc collect"));
    }

    @Test
    public void fullGCWithFullGCGeneration() {
        ns.dispose();

        String output = captureSystemOut(new RevisionsCmd("fullGC", "--entireRepo", "--fullGcGeneration", "2"));
        assertTrue(output.contains("FullGCGeneration is : 2"));
        assertTrue(output.contains("starting gc collect"));
    }

    @Test
    public void embeddedVerification() {
        ns.dispose();

        String output = captureSystemOut(new RevisionsCmd("fullGC", "--entireRepo"));
        assertTrue(output.contains("EmbeddedVerification is enabled : true"));
        assertTrue(output.contains("starting gc collect"));
    }

    @Test
    public void fullGCWithoutEmbeddedVerification() {
        ns.dispose();

        String output = captureSystemOut(new RevisionsCmd("fullGC", "--verify", "false", "--entireRepo"));
        assertTrue(output.contains("EmbeddedVerification is enabled : false"));
        assertTrue(output.contains("starting gc collect"));
    }

    @Test
    public void fullGCWithEmbeddedVerification() {
        ns.dispose();

        String output = captureSystemOut(new RevisionsCmd("fullGC", "--verify", "true", "--entireRepo"));
        assertTrue(output.contains("EmbeddedVerification is enabled : true"));
        assertTrue(output.contains("starting gc collect"));
    }

    @Test
    public void fullGCWithEmbeddedWithoutEntireRepoOrPath() {
        ns.dispose();

        String errOutput = captureSystemErr(new RevisionsCmd("fullGC", "--verify", "true"));
        assertTrue(errOutput.contains("--path or --entireRepo option is required for fullGC command"));
    }

    @Test
    public void auditLoggingEnabled() {
        ns.dispose();

        String output = captureSystemOut(new RevisionsCmd("fullGC", "--entireRepo", "--fullGCAuditLoggingEnabled", "true"));
        assertTrue(output.contains("FullGCAuditLoggingEnabled : true"));
        assertTrue(output.contains("starting gc collect"));
    }

    @Test
    public void auditLoggingDisabled() {
        ns.dispose();

        String output = captureSystemOut(new RevisionsCmd("fullGC", "--entireRepo", "--fullGCAuditLoggingEnabled", "false"));
        assertTrue(output.contains("FullGCAuditLoggingEnabled : false"));
        assertTrue(output.contains("starting gc collect"));
    }

    @Test
    public void auditLoggingNotSet() {
        ns.dispose();

        String output = captureSystemOut(new RevisionsCmd("fullGC", "--entireRepo"));
        assertTrue(output.contains("FullGCAuditLoggingEnabled : false"));
        assertTrue(output.contains("starting gc collect"));
    }

    @Test
    public void fullGCWithEmbeddedWithPath() {
        ns.dispose();

        String output = captureSystemOut(new RevisionsCmd("fullGC", "--verify", "true", "--path", "/"));
        assertTrue(output.contains("EmbeddedVerification is enabled : true"));
        assertTrue(output.contains("running fullGC on the document: /"));
    }

    @Test
    public void fullGCWithEmbeddedWithNonExistingPath() {
        ns.dispose();

        String errOutput = captureSystemErr(new RevisionsCmd("fullGC", "--verify", "true", "--path", "/non-existing-path"));
        assertTrue(errOutput.contains("Document not found: /non-existing-path"));
    }

    @Test
    public void sweep() {
        int clusterId = ns.getClusterId();
        String output = captureSystemErr(new Sweep(clusterId));
        assertThat(output, containsString("cannot sweep revisions for active clusterId"));

        output = captureSystemErr(new Sweep(0));
        assertThat(output, containsString("clusterId option is required"));

        output = captureSystemErr(new Sweep(99));
        assertThat(output, containsString("store does not have changes with clusterId"));

        ns.dispose();
        output = captureSystemOut(new Sweep(clusterId));
        assertThat(output, containsString("Revision sweep not needed for clusterId"));

        // remove the sweep revision to force a sweep run
        MongoConnection c = connectionFactory.getConnection();
        assertNotNull(c);
        DocumentNodeStoreBuilder<?> builder = builderProvider.newBuilder()
                .setMongoDB(c.getMongoClient(), c.getDBName());
        DocumentStore store = builder.getDocumentStore();
        UpdateOp op = new UpdateOp(getIdFromPath("/"), false);
        op.removeMapEntry("_sweepRev", new Revision(0, 0, clusterId));
        assertNotNull(store.findAndUpdate(Collection.NODES, op));

        output = captureSystemOut(new Sweep(clusterId));
        assertThat(output, containsString("Updated sweep revision to"));
    }

    private DocumentNodeStore createDocumentNodeStore() {
        return createDocumentNodeStore(false);
    }

    private DocumentNodeStore createDocumentNodeStore(boolean fullGCEnabled) {
        MongoConnection c = connectionFactory.getConnection();
        assertNotNull(c);
        MongoUtils.dropCollections(c.getDatabase());
        return builderProvider.newBuilder().setFullGCEnabled(fullGCEnabled)
                .setMongoDB(c.getMongoClient(), c.getDBName()).getNodeStore();
    }

    private static class RevisionsCmd implements Runnable {

        private final List<String> args;

        public RevisionsCmd(String... args) {
            List<String> builder = new ArrayList<>();
            builder.add(MongoUtils.URL);
            builder.addAll(Arrays.asList(args));
            this.args = Collections.unmodifiableList(builder);
        }

        @Override
        public void run() {
            try {
                new RevisionsCommand(false).execute(args.toArray(new String[0]));
            } catch (Exception e) {
                throw new RuntimeException(e);
            }
        }
    }

    private static final class Sweep extends RevisionsCmd {

        Sweep(int clusterId) {
            super("sweep", "--clusterId", String.valueOf(clusterId));
        }
    }
}
