com.github.restup.test.RestApiAssertions Maven / Gradle / Ivy

Go to download
package com.github.restup.test;

import com.github.restup.test.resource.Contents;
import com.github.restup.test.resource.RelativeTestResource;

/**
 * Provides a {@link Builder} for RESTful apis with test methods for collection and item resource aligned with http verbs.
 */
public class RestApiAssertions {

    private RestApiAssertions() {
        super();
    }

    public static Builder builder(ApiExecutor executor, Class unitTest, String path, Object... args) {
        return new Builder(executor, unitTest, path, args);
    }

    public static Builder builder(ApiExecutor executor, Object unitTest, String path, Object... args) {
        return new Builder(executor, unitTest, path, args);
    }

    public static Builder builder(ApiExecutor executor, String path, Object... args) {
        return new Builder(executor, path, args);
    }

    public static class Builder {

        private final ApiExecutor executor;
        private final Class unitTest;
        private final String path;
        private final Object[] defaultArgs;
        private boolean itemResource;
        private HttpMethod method;
        private Object[] args;
        private int okStatus = 200;
        private String testName;
        private MediaType mediaType;
        private boolean https;

        Builder(ApiExecutor executor, Class unitTest, String path, Object... args) {
            this.executor = executor;
            this.unitTest = unitTest;
            this.path = path;
            this.defaultArgs = args;
            mediaType = MediaType.APPLICATION_JSON;
        }

        Builder(ApiExecutor executor, Object unitTest, String path, Object... args) {
            this(executor, unitTest.getClass(), path, args);
        }

        Builder(ApiExecutor executor, String path, Object... args) {
            this(executor, RelativeTestResource.getClassFromStack(), path, args);
        }

        private Builder me() {
            return this;
        }

        private Builder method(HttpMethod method) {
            this.method = method;
            return me();
        }

        public Builder jsonapi() {
            return mediaType(MediaType.APPLICATION_JSON_API);
        }

        public Builder hal() {
            return mediaType(MediaType.APPLICATION_JSON_HAL);
        }

        public Builder mediaType(MediaType mediaType) {
            this.mediaType = mediaType;
            return me();
        }

        private Builder args(Object[] args) {
            this.args = args;
            return me();
        }

        private Builder collectionResource() {
            return itemResource(false);
        }

        private Builder itemResource() {
            return itemResource(true);
        }

        private Builder itemResource(boolean item) {
            this.itemResource = item;
            return me();
        }

        /**
         * If true, the test name will be detected and applied automatically based upon the calling method's name
         */
        public Builder test(String testName) {
            this.testName = testName;
            return me();
        }

        public RpcApiAssertions.Builder add(byte[] body, Object... args) {
            return add(args).body(body);
        }

        public RpcApiAssertions.Builder add(String body, Object... args) {
            return add(args).body(body);
        }

        public RpcApiAssertions.Builder add(Contents body, Object... args) {
            return add(args).body(body);
        }

        public RpcApiAssertions.Builder add(Object... args) {
            okStatus = 201;
            return collectionResource()
                    .method(HttpMethod.POST)
                    .args(args)
                    .build();
        }

        public RpcApiAssertions.Builder list(Object... args) {
            return collectionResource()
                    .method(HttpMethod.GET)
                    .args(args)
                    .build();
        }

        public RpcApiAssertions.Builder update(byte[] body, Object... args) {
            return update(args).body(body);
        }

        public RpcApiAssertions.Builder update(String body, Object... args) {
            return update(args).body(body);
        }

        public RpcApiAssertions.Builder update(Contents body, Object... args) {
            return update(args).body(body);
        }

        public RpcApiAssertions.Builder update(Object... args) {
            return itemResource()
                    .method(HttpMethod.PUT)
                    .args(args)
                    .build();
        }

        public RpcApiAssertions.Builder patch(byte[] body, Object... args) {
            return patch(args).body(body);
        }

        public RpcApiAssertions.Builder patch(String body, Object... args) {
            return patch(args).body(body);
        }

        public RpcApiAssertions.Builder patch(Contents body, Object... args) {
            return patch(args).body(body);
        }

        public RpcApiAssertions.Builder patch(Object... args) {
            return itemResource()
                    .method(HttpMethod.PATCH)
                    .args(args)
                    .build();
        }

        public RpcApiAssertions.Builder get(Object... args) {
            return itemResource()
                    .method(HttpMethod.GET)
                    .args(args)
                    .build();
        }

        public RpcApiAssertions.Builder delete(Object... args) {
            return itemResource()
                    .method(HttpMethod.DELETE)
                    .args(args)
                    .build();
        }

        public Builder https() {
            return https(true);
        }

        public Builder https(boolean https) {
            this.https = https;
            return me();
        }

        private RpcApiAssertions.Builder build() {

            String testPath = path;
            if (testPath.contains("}")) {
                if (!itemResource) {
                    // collection resource can't end with id
                    testPath = path.substring(0, path.lastIndexOf('/'));
                }
            } else if (itemResource) {
                // item resource has to end with id
                testPath += "/{id}";
            }

            return new RpcApiAssertions.Builder(executor, unitTest, testPath, defaultArgs)
                    .pathArgs(args)
                    .method(method)
                    .test(testName)
                    .mediaType(mediaType)
                    .https(https)
                    .okStatus(okStatus);
        }

    }
}