io.bdeploy.bhive.op.ManifestConsistencyCheckOperation Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of api Show documentation
Public API including dependencies, ready to be used for integrations and plugins.
The newest version!
package io.bdeploy.bhive.op;

import static io.bdeploy.common.util.RuntimeAssert.assertFalse;

import java.util.ArrayList;
import java.util.List;
import java.util.Set;
import java.util.SortedSet;
import java.util.TreeSet;

import io.bdeploy.bhive.BHive;
import io.bdeploy.bhive.audit.AuditParameterExtractor.AuditStrategy;
import io.bdeploy.bhive.audit.AuditParameterExtractor.AuditWith;
import io.bdeploy.bhive.model.Manifest;
import io.bdeploy.bhive.model.ObjectId;
import io.bdeploy.bhive.objects.view.ElementView;
import io.bdeploy.bhive.objects.view.TreeView;
import io.bdeploy.bhive.objects.view.scanner.TreeVisitor;
import io.bdeploy.common.ActivityReporter.Activity;

/**
 * Operation to check manifest consistency. A {@link Manifest} is considered
 * consistent if all required {@link ObjectId}s are present in the {@link BHive}
 * recursively.
 * 
 * Returns the list of missing/damaged {@link ElementView}s, which identify the underlying elements.
 * 
 * This is a quick check for fundamental consistency, which is complemented by {@link ObjectConsistencyCheckOperation} - which
 * checks each existing and reachable object for actual data integrity.
 */
public class ManifestConsistencyCheckOperation extends BHive.Operation> {

    @AuditWith(AuditStrategy.COLLECTION_PEEK)
    private final SortedSet manifests = new TreeSet<>();
    private boolean dryRun = true;

    @Override
    public Set call() throws Exception {
        assertFalse(manifests.isEmpty(), "Nothing to check");

        Set dmg = new TreeSet<>();
        try (Activity activity = getActivityReporter().start("Checking Manifests", manifests.size())) {
            for (Manifest.Key key : manifests) {
                List broken = new ArrayList<>();

                // it is OK if it no longer exists.
                if (!Boolean.TRUE.equals(execute(new ManifestExistsOperation().setManifest(key)))) {
                    continue;
                }

                TreeView state = execute(new ScanOperation().setManifest(key));
                state.visit(new TreeVisitor.Builder().onMissing(broken::add).build());

                if (!broken.isEmpty() && !dryRun) {
                    execute(new ManifestDeleteOperation().setToDelete(key));
                }

                dmg.addAll(broken);
                activity.workAndCancelIfRequested(1);
            }
        }
        return dmg;
    }

    /**
     * Add a {@link Manifest} to check for consistency.
     */
    public ManifestConsistencyCheckOperation addRoot(Manifest.Key key) {
        manifests.add(key);
        return this;
    }

    public ManifestConsistencyCheckOperation setDryRun(boolean dry) {
        this.dryRun = dry;
        return this;
    }

}