dolthub--dolt/integration-tests/bats/remotesrv.bats

#!/usr/bin/env bats
#
# Tests for remotesrv itself. remotes.bats also uses remotesrv as a testing
# dependency, but it is not technically the unit under test there. This test
# uses dolt remotestorage, clone, pull, fetch, etc., as a dependency but is
# more concerned with covering remotesrv functionality.

load $BATS_TEST_DIRNAME/helper/common.bash

remotesrv_pid=
setup() {
    skiponwindows "tests are flaky on Windows"
    setup_common
}

teardown() {
    stop_remotesrv
    teardown_common
}

stop_remotesrv() {
    if [ -n "$remotesrv_pid" ]; then
        kill "$remotesrv_pid" || :
        wait "$remotesrv_pid" || :
        remotesrv_pid=""
    fi
}

_do_read_from_remotesrv_repo_mode_scenario() {
    local disabled_features="$1"
    if [ -n "$disabled_features" ]; then
        export DOLT_REMOTESAPI_DISABLED_FEATURES="$disabled_features"
    else
        unset DOLT_REMOTESAPI_DISABLED_FEATURES
    fi
    mkdir remote
    mkdir cloned
    cd remote
    dolt init
    dolt sql -q 'create table vals (i int);'
    dolt sql -q 'insert into vals (i) values (1), (2), (3), (4), (5);'
    dolt add vals
    dolt commit -m 'initial vals.'

    remotesrv --http-port 1234 --repo-mode &
    remotesrv_pid=$!

    cd ../cloned
    dolt clone http://localhost:50051/test-org/test-repo repo1
    cd repo1
    run dolt ls
    [[ "$output" =~ "vals" ]] || false
    run dolt sql -q 'select count(*) from vals'
    [[ "$output" =~ "5" ]] || false

    stop_remotesrv
    cd ../../remote
    dolt sql -q 'insert into vals (i) values (6), (7), (8), (9), (10);'
    dolt commit -am 'add some vals'

    remotesrv --http-port 1234 --repo-mode &
    remotesrv_pid=$!

    cd ../cloned/repo1
    dolt pull
    run dolt sql -q 'select count(*) from vals;'
    [[ "$output" =~ "10" ]] || false
}

@test "remotesrv: can read from remotesrv in repo-mode, new RPC" {
    _do_read_from_remotesrv_repo_mode_scenario ""
}

@test "remotesrv: can read from remotesrv in repo-mode, legacy RPC" {
    _do_read_from_remotesrv_repo_mode_scenario "FEATURE_STREAM_CHUNK_LOCATIONS"
}

_do_write_to_remotesrv_repo_mode_scenario() {
    local disabled_features="$1"
    if [ -n "$disabled_features" ]; then
        export DOLT_REMOTESAPI_DISABLED_FEATURES="$disabled_features"
    else
        unset DOLT_REMOTESAPI_DISABLED_FEATURES
    fi
    mkdir remote
    mkdir cloned
    cd remote
    dolt init
    dolt sql -q 'create table vals (i int);'
    dolt add vals
    dolt commit -m 'create vals table.'

    remotesrv --http-port 1234 --repo-mode &
    remotesrv_pid=$!

    cd ../cloned
    dolt clone http://localhost:50051/test-org/test-repo repo1
    cd repo1
    dolt sql -q 'insert into vals values (1), (2), (3), (4), (5);'
    dolt commit -am 'insert some values'
    dolt push origin main:main

    stop_remotesrv
    cd ../../remote
    # Have to reset the working set, which was not updated by the push...
    dolt reset --hard
    run dolt sql -q 'select count(*) from vals;'
    [[ "$output" =~ "5" ]] || false
}

@test "remotesrv: can write to remotesrv in repo-mode, new RPC" {
    _do_write_to_remotesrv_repo_mode_scenario ""
}

@test "remotesrv: can write to remotesrv in repo-mode, legacy RPC" {
    _do_write_to_remotesrv_repo_mode_scenario "FEATURE_STREAM_CHUNK_LOCATIONS"
}

@test "remotesrv: pushing new branch to remotesrv does not create new working set" {
    mkdir remote
    mkdir cloned
    cd remote
    dolt init
    dolt sql -q 'create table vals (i int);'
    dolt add vals
    dolt commit -m 'create vals table.'

    remotesrv --http-port 1234 --repo-mode &
    remotesrv_pid=$!

    cd ../cloned
    dolt clone http://localhost:50051/test-org/test-repo repo1
    cd repo1
    dolt sql -q 'insert into vals values (1), (2), (3), (4), (5);'
    dolt commit -am 'insert some values'
    dolt push origin main:new_branch

    stop_remotesrv
    cd ../../remote
    run dolt admin show-root
    echo "$output"
    [ "$status" -eq 0 ]
    [[ ! "$output" =~ "workingSets/heads/new_branch" ]] || false
    [[ "$output" =~ "workingSets/heads/main" ]] || false
}

@test "remotesrv: can write to remotesrv when repo has a dirty working set" {
    mkdir remote
    mkdir cloned
    cd remote
    dolt init
    dolt sql -q 'create table vals (i int);'
    dolt add vals
    dolt commit -m 'create vals table.'
    dolt sql -q 'insert into vals values (38320)' # Dirty the remote.

    remotesrv --http-port 1234 --repo-mode &
    remotesrv_pid=$!

    cd ../cloned
    dolt clone http://localhost:50051/test-org/test-repo repo1
    cd repo1
    dolt sql -q 'insert into vals values (9778), (12433);'
    dolt commit -am 'insert two unique values'
    dolt push origin main:main

    stop_remotesrv
    cd ../../remote

    # HEAD has the pushed value.
    run dolt show
    [[ "$status" -eq 0 ]] || false
    [[ "$output" =~ "insert two unique values" ]] || false

    # and that working set is still dirty (won't include HEAD values)
    run dolt diff
    [[ "$status" -eq 0 ]] || false
    [[ "$output" =~ "+ | 38320" ]] || false

    run dolt diff --cached
    [[ "$status" -eq 0 ]] || false
    [[ "$output" =~ "- | 9778" ]] || false
    [[ "$output" =~ "- | 12433" ]] || false
}

@test "remotesrv: read only server rejects writes" {
    mkdir remote
    mkdir cloned
    cd remote
    dolt init
    dolt sql -q 'create table vals (i int);'
    dolt add vals
    dolt commit -m 'create vals table.'

    remotesrv --http-port 1234 --repo-mode -read-only &
    remotesrv_pid=$!

    cd ../cloned
    dolt clone http://localhost:50051/test-org/test-repo repo1
    cd repo1
    dolt sql -q 'insert into vals values (1), (2), (3), (4), (5);'
    dolt commit -am 'insert some values'
    run dolt push origin main:main
    [[ "$status" != 0 ]] || false
}

_do_grpc_and_http_same_port_scenario() {
    local disabled_features="$1"
    if [ -n "$disabled_features" ]; then
        export DOLT_REMOTESAPI_DISABLED_FEATURES="$disabled_features"
    else
        unset DOLT_REMOTESAPI_DISABLED_FEATURES
    fi
    mkdir remote
    mkdir cloned
    cd remote
    dolt init
    dolt sql -q 'create table vals (i int);'
    dolt add vals
    dolt commit -m 'create vals table.'

    remotesrv --grpc-port 1234 --http-port 1234 --repo-mode &
    remotesrv_pid=$!

    cd ../cloned
    dolt clone http://localhost:1234/test-org/test-repo repo1
}

@test "remotesrv: can run grpc and http on same port, new RPC" {
    _do_grpc_and_http_same_port_scenario ""
}

@test "remotesrv: can run grpc and http on same port, legacy RPC" {
    _do_grpc_and_http_same_port_scenario "FEATURE_STREAM_CHUNK_LOCATIONS"
}