dolt/integration-tests/bats/reflog.bats

#!/usr/bin/env bats
load $BATS_TEST_DIRNAME/helper/common.bash

teardown() {
    assert_feature_version
    teardown_common
}

# Asserts that when DOLT_DISABLE_REFLOG is set, dolt reflog returns nothing with no error.
@test "reflog: disabled with DOLT_DISABLE_REFLOG" {
    export DOLT_DISABLE_REFLOG=true
    setup_common    # need to set env vars before setup_common for remote tests

    dolt sql -q "create table t (i int primary key, j int);"
    dolt sql -q "insert into t values (1, 1), (2, 2), (3, 3)";
    dolt commit -Am "initial commit"
    dolt commit --allow-empty -m "test commit 1"

    run dolt reflog
    [ "$status" -eq 0 ]
    [ "${#lines[@]}" -eq 0 ]
}

# Asserts that when DOLT_REFLOG_RECORD_LIMIT has been set, the reflog only contains the
# most recent entries and is limited by the env var's value.
@test "reflog: set DOLT_REFLOG_RECORD_LIMIT" {
    export DOLT_REFLOG_RECORD_LIMIT=2
    setup_common    # need to set env vars before setup_common for remote tests

    dolt sql -q "create table t (i int primary key, j int);"
    dolt sql -q "insert into t values (1, 1), (2, 2), (3, 3)";
    dolt commit -Am "initial commit"
    dolt commit --allow-empty -m "test commit 1"
    dolt commit --allow-empty -m "test commit 2"

    # Only the most recent two ref changes should appear in the log
    run dolt reflog
    [ "$status" -eq 0 ]
    [[ "$output" =~ "test commit 1" ]] || false
    [[ "$output" =~ "test commit 2" ]] || false
    [[ ! "$output" =~ "initial commit" ]] || false
    [[ ! "$output" =~ "Initialize data repository" ]] || false
}

@test "reflog: simple reflog" {
    setup_common

    dolt sql -q "create table t (i int primary key, j int);"
    dolt sql -q "insert into t values (1, 1), (2, 2), (3, 3)";
    dolt commit -Am "initial commit"

    run dolt reflog
    [ "$status" -eq 0 ]
    [ "${#lines[@]}" -eq 2 ]
    out=$(echo "$output" | sed -E 's/\x1b\[[0-9;]*m//g') # remove special characters for color
    [[ "$out" =~ "(HEAD -> main) initial commit" ]] || false
    [[ "$out" =~ "Initialize data repository" ]] || false
}

@test "reflog: reflog with ref given" {
    setup_common

    dolt sql <<SQL
create table t1(pk int primary key);
call dolt_commit('-Am', 'creating table t1');

insert into t1 values(1);
call dolt_commit('-Am', 'inserting row 1');
call dolt_tag('tag1');

call dolt_checkout('-b', 'branch1');
insert into t1 values(2);
call dolt_commit('-Am', 'inserting row 2');

insert into t1 values(3);
call dolt_commit('-Am', 'inserting row 3');
call dolt_tag('-d', 'tag1');
call dolt_tag('tag1');
SQL

    run dolt reflog refs/heads/main
    [ "$status" -eq 0 ]
    [ "${#lines[@]}" -eq 3 ]
    out=$(echo "$output" | sed -E 's/\x1b\[[0-9;]*m//g') # remove special characters for color
    [[ "$out" =~ "(HEAD -> main) inserting row 1" ]] || false
    [[ "$out" =~ "creating table t1" ]] || false
    [[ "$out" =~ "Initialize data repository" ]] || false

    # ref is case-insensitive
    run dolt reflog rEFs/heAdS/MAIN
    [ "$status" -eq 0 ]
    [ "${#lines[@]}" -eq 3 ]
    out=$(echo "$output" | sed -E 's/\x1b\[[0-9;]*m//g') # remove special characters for color
    [[ "$out" =~ "(HEAD -> main) inserting row 1" ]] || false
    [[ "$out" =~ "creating table t1" ]] || false
    [[ "$out" =~ "Initialize data repository" ]] || false

    run dolt reflog main
    [ "$status" -eq 0 ]
    [ "${#lines[@]}" -eq 3 ]
    out=$(echo "$output" | sed -E 's/\x1b\[[0-9;]*m//g') # remove special characters for color
    [[ "$out" =~ "(HEAD -> main) inserting row 1" ]] || false
    [[ "$out" =~ "creating table t1" ]] || false
    [[ "$out" =~ "Initialize data repository" ]] || false

    # ref is case-insensitive
    run dolt reflog MaIn
    [ "$status" -eq 0 ]
    [ "${#lines[@]}" -eq 3 ]
    out=$(echo "$output" | sed -E 's/\x1b\[[0-9;]*m//g') # remove special characters for color
    [[ "$out" =~ "(HEAD -> main) inserting row 1" ]] || false
    [[ "$out" =~ "creating table t1" ]] || false
    [[ "$out" =~ "Initialize data repository" ]] || false

    run dolt reflog refs/heads/branch1
    [ "$status" -eq 0 ]
    [ "${#lines[@]}" -eq 3 ]
    out=$(echo "$output" | sed -E 's/\x1b\[[0-9;]*m//g') # remove special characters for color
    [[ "$out" =~ "(branch1) inserting row 3" ]] || false
    [[ "$out" =~ "inserting row 2" ]] || false
    [[ "$out" =~ "inserting row 1" ]] || false

    run dolt reflog branch1
    [ "$status" -eq 0 ]
    [ "${#lines[@]}" -eq 3 ]
    out=$(echo "$output" | sed -E 's/\x1b\[[0-9;]*m//g') # remove special characters for color
    [[ "$out" =~ "(branch1) inserting row 3" ]] || false
    [[ "$out" =~ "inserting row 2" ]] || false
    [[ "$out" =~ "inserting row 1" ]] || false

    run dolt reflog refs/tags/tag1
    [ "$status" -eq 0 ]
    [ "${#lines[@]}" -eq 2 ]
    out=$(echo "$output" | sed -E 's/\x1b\[[0-9;]*m//g') # remove special characters for color
    [[ "$out" =~ "(tag: tag1) inserting row 3" ]] || false
    [[ "$out" =~ "inserting row 1" ]] || false

    # ref is case-insensitive
    run dolt reflog Refs/tAGs/TaG1
    [ "$status" -eq 0 ]
    [ "${#lines[@]}" -eq 2 ]
    out=$(echo "$output" | sed -E 's/\x1b\[[0-9;]*m//g') # remove special characters for color
    [[ "$out" =~ "(tag: tag1) inserting row 3" ]] || false
    [[ "$out" =~ "inserting row 1" ]] || false

    run dolt reflog tag1
    [ "$status" -eq 0 ]
    [ "${#lines[@]}" -eq 2 ]
    out=$(echo "$output" | sed -E 's/\x1b\[[0-9;]*m//g') # remove special characters for color
    [[ "$out" =~ "(tag: tag1) inserting row 3" ]] || false
    [[ "$out" =~ "inserting row 1" ]] || false

    # ref is case-insensitive
    run dolt reflog TAg1
    [ "$status" -eq 0 ]
    [ "${#lines[@]}" -eq 2 ]
    out=$(echo "$output" | sed -E 's/\x1b\[[0-9;]*m//g') # remove special characters for color
    [[ "$out" =~ "(tag: tag1) inserting row 3" ]] || false
    [[ "$out" =~ "inserting row 1" ]] || false

    dolt branch -D branch1

    run dolt reflog branch1
    [ "$status" -eq 0 ]
    [ "${#lines[@]}" -eq 3 ]
    out=$(echo "$output" | sed -E 's/\x1b\[[0-9;]*m//g') # remove special characters for color
    [[ "$out" =~ "(branch1) inserting row 3" ]] || false
    [[ "$out" =~ "inserting row 2" ]] || false
    [[ "$out" =~ "inserting row 1" ]] || false

    dolt tag -d tag1
    run dolt reflog tag1
    [ "$status" -eq 0 ]
    [ "${#lines[@]}" -eq 2 ]
    out=$(echo "$output" | sed -E 's/\x1b\[[0-9;]*m//g') # remove special characters for color
    [[ "$out" =~ "(tag: tag1) inserting row 3" ]] || false
    [[ "$out" =~ "inserting row 1" ]] || false
}

@test "reflog: garbage collection with no newgen data" {
    setup_common

    run dolt reflog
    [ "$status" -eq 0 ]
    [ "${#lines[@]}" -eq 1 ]
    out=$(echo "$output" | sed -E 's/\x1b\[[0-9;]*m//g') # remove special characters for color
    [[ "$out" =~ "(HEAD -> main) Initialize data repository" ]] || false

    dolt gc

    run dolt reflog
    [ "$status" -eq 0 ]
    [ "${#lines[@]}" -eq 0 ]
}

@test "reflog: garbage collection with newgen data" {
    setup_common

    dolt sql <<SQL
create table t1(pk int primary key);
call dolt_commit('-Am', 'creating table t1');
insert into t1 values(1);
call dolt_commit('-Am', 'inserting row 1');
call dolt_tag('tag1');
insert into t1 values(2);
call dolt_commit('-Am', 'inserting row 2');
SQL

    run dolt reflog main
    [ "$status" -eq 0 ]
    [ "${#lines[@]}" -eq 4 ]
    out=$(echo "$output" | sed -E 's/\x1b\[[0-9;]*m//g') # remove special characters for color
    [[ "$out" =~ "(HEAD -> main) inserting row 2" ]] || false
    [[ "$out" =~ "inserting row 1" ]] || false
    [[ "$out" =~ "creating table t1" ]] || false
    [[ "$out" =~ "Initialize data repository" ]] || false

    dolt gc

    run dolt reflog main
    [ "$status" -eq 0 ]
    [ "${#lines[@]}" -eq 0 ]
}

@test "reflog: too many arguments given" {
    setup_common

    run dolt reflog foo bar
    [ "$status" -eq 1 ]
    [[ "$output" =~ "error: reflog has too many positional arguments" ]] || false
}

@test "reflog: unknown ref returns nothing" {
    setup_common

    dolt sql -q "create table t (i int primary key, j int);"
    dolt sql -q "insert into t values (1, 1), (2, 2), (3, 3)";
    dolt commit -Am "initial commit"

    run dolt reflog foo
    [ "$status" -eq 0 ]
    [ "${#lines[@]}" -eq 0 ]
}

@test "reflog: 'HEAD -> ' decoration only appears on HEAD entries" {
    setup_common

    dolt sql -q "create table t (i int primary key, j int);"
    dolt sql -q "insert into t values (1, 1), (2, 2), (3, 3)";
    dolt commit -Am "initial commit"

    run dolt reflog
    [ "$status" -eq 0 ]
    [ "${#lines[@]}" -eq 2 ]
    line1=$(echo "${lines[0]}" | sed -E 's/\x1b\[[0-9;]*m//g') # remove special characters for color
    line2=$(echo "${lines[1]}" | sed -E 's/\x1b\[[0-9;]*m//g') # remove special characters for color
    [[ "$line1" =~ "(HEAD -> main) initial commit" ]] || false
    [[ "$line2" =~ "Initialize data repository" ]] || false
    [[ ! "$line2" =~ "HEAD" ]] || false
}