org.deltafi.test.action.TestCaseBase Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of deltafi-action-kit-test Show documentation

DeltaFi Action Kit Test Harness - Test Action implementation SDK for DeltaFi actions

There is a newer version: 2.0-rc2

Show newest version

/*
 *    DeltaFi - Data transformation and enrichment platform
 *
 *    Copyright 2021-2023 DeltaFi Contributors 
 *
 *    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.deltafi.test.action;

import lombok.*;
import lombok.experimental.SuperBuilder;
import org.deltafi.actionkit.action.Action;
import org.deltafi.actionkit.action.Result;
import org.deltafi.actionkit.action.ResultType;
import org.deltafi.actionkit.action.error.ErrorResult;
import org.deltafi.actionkit.action.filter.FilterResult;
import org.deltafi.actionkit.action.parameters.ActionParameters;

import java.util.Collections;
import java.util.List;
import java.util.Map;
import java.util.regex.Pattern;

/**
 * @deprecated Use the DeltaFiTestRunner to set up the test and run the action directly.
 * The result can be verified using {@link org.deltafi.test.asserters.ActionResultAssertions}.
 */
@Deprecated
@Data
@EqualsAndHashCode
@SuperBuilder
public class TestCaseBase> {

    private Class> expectedResultType;

    public A action;

    public Map parameters;

    public String testName;

    @Builder.Default
    private List inputs = Collections.emptyList();

    private Map sourceMetadata;

    @Builder.Default
    private List outputs = Collections.emptyList();

    @Builder.Default
    private Map resultMetadata = Collections.emptyMap();

    @Builder.Default
    private List resultDeleteMetadataKeys = Collections.emptyList();

    private Pattern regex;

    @Builder.Default
    private Throwable exception = null;

    @Builder.Default
    private ExceptionLocation exceptionLocation = ExceptionLocation.NONE;

    public enum ExceptionLocation {
        NONE,
        STORAGE_READ,
        STORAGE_WRITE
    }

    public static abstract class TestCaseBaseBuilder, C extends TestCaseBase, B extends TestCaseBase.TestCaseBaseBuilder> {

        public B expectError(String errorRegex) {
            return expectError(Pattern.compile(errorRegex));
        }

        public B expectError(Pattern errorRegex) {
            expectedResultType(ErrorResult.class);
            regex(errorRegex);

            return self();
        }

        public B expectFilter(String filterRegex) { return expectFilter(Pattern.compile(filterRegex)); }

        public B expectFilter(Pattern filterRegex) {
            expectedResultType(FilterResult.class);
            regex(filterRegex);

            return self();
        }
    }
}