src/test/java/org/apache/cassandra/sidecar/routes/StreamSSTableComponentHandlerTest.java

/*
 * 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.cassandra.sidecar.routes;

import java.util.concurrent.CountDownLatch;
import java.util.concurrent.TimeUnit;

import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.google.inject.Guice;
import com.google.inject.Injector;
import com.google.inject.util.Modules;
import io.vertx.core.Vertx;
import io.vertx.core.http.HttpServer;
import io.vertx.ext.web.client.WebClient;
import io.vertx.ext.web.codec.BodyCodec;
import io.vertx.junit5.VertxExtension;
import io.vertx.junit5.VertxTestContext;
import org.apache.cassandra.sidecar.Configuration;
import org.apache.cassandra.sidecar.MainModule;
import org.apache.cassandra.sidecar.TestModule;

import static io.netty.handler.codec.http.HttpResponseStatus.BAD_REQUEST;
import static io.netty.handler.codec.http.HttpResponseStatus.FORBIDDEN;
import static io.netty.handler.codec.http.HttpResponseStatus.NOT_FOUND;
import static io.netty.handler.codec.http.HttpResponseStatus.OK;
import static io.netty.handler.codec.http.HttpResponseStatus.PARTIAL_CONTENT;
import static io.netty.handler.codec.http.HttpResponseStatus.REQUESTED_RANGE_NOT_SATISFIABLE;
import static org.assertj.core.api.Assertions.assertThat;

/**
 * Test for StreamSSTableComponent
 */
@ExtendWith(VertxExtension.class)
public class StreamSSTableComponentHandlerTest
{
    private static final Logger logger = LoggerFactory.getLogger(StreamSSTableComponentHandlerTest.class);
    private Vertx vertx;
    private HttpServer server;
    private Configuration config;

    @BeforeEach
    void setUp() throws InterruptedException
    {
        Injector injector = Guice.createInjector(Modules.override(new MainModule()).with(new TestModule()));
        server = injector.getInstance(HttpServer.class);
        vertx = injector.getInstance(Vertx.class);
        config = injector.getInstance(Configuration.class);

        VertxTestContext context = new VertxTestContext();
        server.listen(config.getPort(), context.succeedingThenComplete());

        context.awaitCompletion(5, TimeUnit.SECONDS);
    }

    @AfterEach
    void tearDown() throws InterruptedException
    {
        final CountDownLatch closeLatch = new CountDownLatch(1);
        server.close(res -> closeLatch.countDown());
        vertx.close();
        if (closeLatch.await(60, TimeUnit.SECONDS))
            logger.info("Close event received before timeout.");
        else
            logger.error("Close event timed out.");
    }

    @Test
    void testRoute(VertxTestContext context)
    {
        WebClient client = WebClient.create(vertx);
        String testRoute = "/keyspace/TestKeyspace/table/TestTable-54ea95ce-bba2-4e0a-a9be-e428e5d7160b/snapshots" +
                "/TestSnapshot/component/TestKeyspace-TestTable-54ea95ce-bba2-4e0a-a9be-e428e5d7160b-Data.db";
        client.get(config.getPort(), "localhost", "/api/v1" + testRoute)
                .as(BodyCodec.buffer())
                .send(context.succeeding(response -> context.verify(() ->
                {
                    assertThat(response.statusCode()).isEqualTo(OK.code());
                    assertThat(response.bodyAsString()).isEqualTo("data");
                    context.completeNow();
                })));
    }

    @Test
    void testKeyspaceNotFound(VertxTestContext context)
    {
        WebClient client = WebClient.create(vertx);
        String testRoute = "/keyspace/random/table/TestTable-54ea95ce-bba2-4e0a-a9be-e428e5d7160b/snapshots" +
                "/TestSnapshot/component/TestKeyspace-TestTable-54ea95ce-bba2-4e0a-a9be-e428e5d7160b-Data.db";
        client.get(config.getPort(), "localhost", "/api/v1" + testRoute)
                .send(context.succeeding(response -> context.verify(() ->
                {
                    assertThat(response.statusCode()).isEqualTo(NOT_FOUND.code());
                    context.completeNow();
                })));
    }

    @Test
    void testSnapshotNotFound(VertxTestContext context)
    {
        WebClient client = WebClient.create(vertx);
        String testRoute = "/keyspace/TestKeyspace/table/TestTable-54ea95ce-bba2-4e0a-a9be-e428e5d7160b/snapshots" +
                "/random/component/TestKeyspace-TestTable-54ea95ce-bba2-4e0a-a9be-e428e5d7160b-Data.db";
        client.get(config.getPort(), "localhost", "/api/v1" + testRoute)
                .send(context.succeeding(response -> context.verify(() ->
                {
                    assertThat(response.statusCode()).isEqualTo(NOT_FOUND.code());
                    context.completeNow();
                })));
    }

    @Test
    void testForbiddenKeyspace(VertxTestContext context)
    {
        WebClient client = WebClient.create(vertx);
        String testRoute = "/keyspace/system/table/TestTable-54ea95ce-bba2-4e0a-a9be-e428e5d7160b/snapshots" +
                "/TestSnapshot/component/TestKeyspace-TestTable-54ea95ce-bba2-4e0a-a9be-e428e5d7160b-Data.db";
        client.get(config.getPort(), "localhost", "/api/v1" + testRoute)
                .send(context.succeeding(response -> context.verify(() ->
                {
                    assertThat(response.statusCode()).isEqualTo(FORBIDDEN.code());
                    assertThat(response.statusMessage()).isEqualTo(FORBIDDEN.reasonPhrase());
                    context.completeNow();
                })));
    }

    @Test
    void testIncorrectKeyspaceFormat(VertxTestContext context)
    {
        WebClient client = WebClient.create(vertx);
        String testRoute = "/keyspace/k*s/table/TestTable-54ea95ce-bba2-4e0a-a9be-e428e5d7160b/snapshots" +
                "/TestSnapshot/component/TestKeyspace-TestTable-54ea95ce-bba2-4e0a-a9be-e428e5d7160b-Data.db";
        client.get(config.getPort(), "localhost", "/api/v1" + testRoute)
                .send(context.succeeding(response -> context.verify(() ->
                {
                    assertThat(response.statusCode()).isEqualTo(BAD_REQUEST.code());
                    assertThat(response.statusMessage()).isEqualTo(BAD_REQUEST.reasonPhrase());
                    context.completeNow();
                })));
    }

    @Test
    void testIncorrectComponentFormat(VertxTestContext context)
    {
        WebClient client = WebClient.create(vertx);
        String testRoute = "/keyspace/TestKeyspace/table/TestTable-54ea95ce-bba2-4e0a-a9be-e428e5d7160b/snapshots" +
                "/TestSnapshot/component/TestKeyspace-TestTable-54ea95ce-bba2-4e0a-a9be-e428e5d7160b-Data...db";
        client.get(config.getPort(), "localhost", "/api/v1" + testRoute)
                .send(context.succeeding(response -> context.verify(() ->
                {
                    assertThat(response.statusCode()).isEqualTo(BAD_REQUEST.code());
                    assertThat(response.statusMessage()).isEqualTo(BAD_REQUEST.reasonPhrase());
                    context.completeNow();
                })));
    }

    @Test
    void testAccessDeniedToCertainComponents(VertxTestContext context)
    {
        WebClient client = WebClient.create(vertx);
        String testRoute = "/keyspace/TestKeyspace/table/TestTable-54ea95ce-bba2-4e0a-a9be-e428e5d7160b/snapshots" +
                "/TestSnapshot/component/TestKeyspace-TestTable-54ea95ce-bba2-4e0a-a9be-e428e5d7160b-Digest.crc32d";
        client.get(config.getPort(), "localhost", "/api/v1" + testRoute)
                .send(context.succeeding(response -> context.verify(() ->
                {
                    assertThat(response.statusCode()).isEqualTo(BAD_REQUEST.code());
                    assertThat(response.statusMessage()).isEqualTo(BAD_REQUEST.reasonPhrase());
                    context.completeNow();
                })));
    }

    @Test
    void testPartialTableName(VertxTestContext context)
    {
        WebClient client = WebClient.create(vertx);
        String testRoute = "/keyspace/TestKeyspace/table/TestTable/snapshots/TestSnapshot/component" +
                "/TestKeyspace-TestTable-54ea95ce-bba2-4e0a-a9be-e428e5d7160b-Data.db";
        client.get(config.getPort(), "localhost", "/api/v1" + testRoute)
                .putHeader("Range", "bytes=0-")
                .as(BodyCodec.buffer())
                .send(context.succeeding(response -> context.verify(() ->
                {
                    assertThat(response.statusCode()).isEqualTo(OK.code());
                    assertThat(response.bodyAsString()).isEqualTo("data");
                    context.completeNow();
                })));
    }

    @Test
    void testInvalidRange(VertxTestContext context)
    {
        WebClient client = WebClient.create(vertx);
        String testRoute = "/keyspace/TestKeyspace/table/TestTable-54ea95ce-bba2-4e0a-a9be-e428e5d7160b/snapshots" +
                "/TestSnapshot/component/TestKeyspace-TestTable-54ea95ce-bba2-4e0a-a9be-e428e5d7160b-Data.db";
        client.get(config.getPort(), "localhost", "/api/v1" + testRoute)
                .putHeader("Range", "bytes=4-3")
                .send(context.succeeding(response -> context.verify(() ->
                {
                    assertThat(response.statusCode()).isEqualTo(REQUESTED_RANGE_NOT_SATISFIABLE.code());
                    context.completeNow();
                })));
    }

    @Test
    void testRangeExceeds(VertxTestContext context)
    {
        WebClient client = WebClient.create(vertx);
        String testRoute = "/keyspace/TestKeyspace/table/TestTable-54ea95ce-bba2-4e0a-a9be-e428e5d7160b/snapshots" +
                "/TestSnapshot/component/TestKeyspace-TestTable-54ea95ce-bba2-4e0a-a9be-e428e5d7160b-Data.db";
        client.get(config.getPort(), "localhost", "/api/v1" + testRoute)
                .putHeader("Range", "bytes=5-9")
                .send(context.succeeding(response -> context.verify(() ->
                {
                    assertThat(response.statusCode()).isEqualTo(REQUESTED_RANGE_NOT_SATISFIABLE.code());
                    context.completeNow();
                })));
    }

    @Test
    void testPartialRangeExceeds(VertxTestContext context)
    {
        WebClient client = WebClient.create(vertx);
        String testRoute = "/keyspace/TestKeyspace/table/TestTable-54ea95ce-bba2-4e0a-a9be-e428e5d7160b/snapshots" +
                "/TestSnapshot/component/TestKeyspace-TestTable-54ea95ce-bba2-4e0a-a9be-e428e5d7160b-Data.db";
        client.get(config.getPort(), "localhost", "/api/v1" + testRoute)
                .putHeader("Range", "bytes=5-")
                .send(context.succeeding(response -> context.verify(() ->
                {
                    assertThat(response.statusCode()).isEqualTo(REQUESTED_RANGE_NOT_SATISFIABLE.code());
                    context.completeNow();
                })));
    }

    @Test
    void testRangeBoundaryExceeds(VertxTestContext context)
    {
        WebClient client = WebClient.create(vertx);
        String testRoute = "/keyspace/TestKeyspace/table/TestTable-54ea95ce-bba2-4e0a-a9be-e428e5d7160b/snapshots" +
                "/TestSnapshot/component/TestKeyspace-TestTable-54ea95ce-bba2-4e0a-a9be-e428e5d7160b-Data.db";
        client.get(config.getPort(), "localhost", "/api/v1" + testRoute)
                .putHeader("Range", "bytes=0-999999")
                .as(BodyCodec.buffer())
                .send(context.succeeding(response -> context.verify(() ->
                {
                    assertThat(response.statusCode()).isEqualTo(OK.code());
                    assertThat(response.bodyAsString()).isEqualTo("data");
                    context.completeNow();
                })));
    }

    @Test
    void testPartialRangeStreamed(VertxTestContext context)
    {
        WebClient client = WebClient.create(vertx);
        String testRoute = "/keyspace/TestKeyspace/table/TestTable-54ea95ce-bba2-4e0a-a9be-e428e5d7160b/snapshots" +
                "/TestSnapshot/component/TestKeyspace-TestTable-54ea95ce-bba2-4e0a-a9be-e428e5d7160b-Data.db";
        client.get(config.getPort(), "localhost", "/api/v1" + testRoute)
                .putHeader("Range", "bytes=0-2") // 3 bytes streamed
                .as(BodyCodec.buffer())
                .send(context.succeeding(response -> context.verify(() ->
                {
                    assertThat(response.statusCode()).isEqualTo(PARTIAL_CONTENT.code());
                    assertThat(response.bodyAsString()).isEqualTo("dat");
                    context.completeNow();
                })));
    }

    @Test
    void testSuffixRange(VertxTestContext context)
    {
        WebClient client = WebClient.create(vertx);
        String testRoute = "/keyspace/TestKeyspace/table/TestTable-54ea95ce-bba2-4e0a-a9be-e428e5d7160b/snapshots" +
                "/TestSnapshot/component/TestKeyspace-TestTable-54ea95ce-bba2-4e0a-a9be-e428e5d7160b-Data.db";
        client.get(config.getPort(), "localhost", "/api/v1" + testRoute)
                .putHeader("Range", "bytes=-2") // last 2 bytes streamed
                .as(BodyCodec.buffer())
                .send(context.succeeding(response -> context.verify(() ->
                {
                    assertThat(response.statusCode()).isEqualTo(PARTIAL_CONTENT.code());
                    assertThat(response.bodyAsString()).isEqualTo("ta");
                    context.completeNow();
                })));
    }

    @Test
    void testSuffixRangeExceeds(VertxTestContext context)
    {
        WebClient client = WebClient.create(vertx);
        String testRoute = "/keyspace/TestKeyspace/table/TestTable-54ea95ce-bba2-4e0a-a9be-e428e5d7160b/snapshots" +
                "/TestSnapshot/component/TestKeyspace-TestTable-54ea95ce-bba2-4e0a-a9be-e428e5d7160b-Data.db";
        client.get(config.getPort(), "localhost", "/api/v1" + testRoute)
                .putHeader("Range", "bytes=-5")
                .send(context.succeeding(response -> context.verify(() ->
                {
                    assertThat(response.statusCode()).isEqualTo(REQUESTED_RANGE_NOT_SATISFIABLE.code());
                    context.completeNow();
                })));
    }

    @Test
    void testInvalidRangeUnit(VertxTestContext context)
    {
        WebClient client = WebClient.create(vertx);
        String testRoute = "/keyspace/TestKeyspace/table/TestTable-54ea95ce-bba2-4e0a-a9be-e428e5d7160b/snapshots" +
                "/TestSnapshot/component/TestKeyspace-TestTable-54ea95ce-bba2-4e0a-a9be-e428e5d7160b-Data.db";
        client.get(config.getPort(), "localhost", "/api/v1" + testRoute)
                .putHeader("Range", "bits=0-2")
                .send(context.succeeding(response -> context.verify(() ->
                {
                    assertThat(response.statusCode()).isEqualTo(REQUESTED_RANGE_NOT_SATISFIABLE.code());
                    context.completeNow();
                })));
    }

    @Test
    void testStreamingFromSpecificInstance(VertxTestContext context)
    {
        WebClient client = WebClient.create(vertx);
        String testRoute = "/keyspace/TestKeyspace/table/TestTable-54ea95ce-bba2-4e0a-a9be-e428e5d7160b/" +
                           "snapshots/TestSnapshot/component/" +
                           "TestKeyspace-TestTable-54ea95ce-bba2-4e0a-a9be-e428e5d7160b-Data.db";
        client.get(config.getPort(), "localhost", "/api/v1" + testRoute + "?instanceId=2")
              .as(BodyCodec.buffer())
              .send(context.succeeding(response -> context.verify(() ->
              {
                  assertThat(response.statusCode()).isEqualTo(OK.code());
                  assertThat(response.bodyAsString()).isEqualTo("data");
                  context.completeNow();
              })));
    }
}