t / t5319-multi-pack-index.shon commit trace2: correct trace2 field name documentation (24df0d4)
   1#!/bin/sh
   2
   3test_description='multi-pack-indexes'
   4. ./test-lib.sh
   5
   6objdir=.git/objects
   7
   8midx_read_expect () {
   9        NUM_PACKS=$1
  10        NUM_OBJECTS=$2
  11        NUM_CHUNKS=$3
  12        OBJECT_DIR=$4
  13        EXTRA_CHUNKS="$5"
  14        {
  15                cat <<-EOF &&
  16                header: 4d494458 1 $NUM_CHUNKS $NUM_PACKS
  17                chunks: pack-names oid-fanout oid-lookup object-offsets$EXTRA_CHUNKS
  18                num_objects: $NUM_OBJECTS
  19                packs:
  20                EOF
  21                if test $NUM_PACKS -ge 1
  22                then
  23                        ls $OBJECT_DIR/pack/ | grep idx | sort
  24                fi &&
  25                printf "object-dir: $OBJECT_DIR\n"
  26        } >expect &&
  27        test-tool read-midx $OBJECT_DIR >actual &&
  28        test_cmp expect actual
  29}
  30
  31test_expect_success 'write midx with no packs' '
  32        test_when_finished rm -f pack/multi-pack-index &&
  33        git multi-pack-index --object-dir=. write &&
  34        midx_read_expect 0 0 4 .
  35'
  36
  37generate_objects () {
  38        i=$1
  39        iii=$(printf '%03i' $i)
  40        {
  41                test-tool genrandom "bar" 200 &&
  42                test-tool genrandom "baz $iii" 50
  43        } >wide_delta_$iii &&
  44        {
  45                test-tool genrandom "foo"$i 100 &&
  46                test-tool genrandom "foo"$(( $i + 1 )) 100 &&
  47                test-tool genrandom "foo"$(( $i + 2 )) 100
  48        } >deep_delta_$iii &&
  49        {
  50                echo $iii &&
  51                test-tool genrandom "$iii" 8192
  52        } >file_$iii &&
  53        git update-index --add file_$iii deep_delta_$iii wide_delta_$iii
  54}
  55
  56commit_and_list_objects () {
  57        {
  58                echo 101 &&
  59                test-tool genrandom 100 8192;
  60        } >file_101 &&
  61        git update-index --add file_101 &&
  62        tree=$(git write-tree) &&
  63        commit=$(git commit-tree $tree -p HEAD</dev/null) &&
  64        {
  65                echo $tree &&
  66                git ls-tree $tree | sed -e "s/.* \\([0-9a-f]*\\)        .*/\\1/"
  67        } >obj-list &&
  68        git reset --hard $commit
  69}
  70
  71test_expect_success 'create objects' '
  72        test_commit initial &&
  73        for i in $(test_seq 1 5)
  74        do
  75                generate_objects $i
  76        done &&
  77        commit_and_list_objects
  78'
  79
  80test_expect_success 'write midx with one v1 pack' '
  81        pack=$(git pack-objects --index-version=1 $objdir/pack/test <obj-list) &&
  82        test_when_finished rm $objdir/pack/test-$pack.pack \
  83                $objdir/pack/test-$pack.idx $objdir/pack/multi-pack-index &&
  84        git multi-pack-index --object-dir=$objdir write &&
  85        midx_read_expect 1 18 4 $objdir
  86'
  87
  88midx_git_two_modes () {
  89        git -c core.multiPackIndex=false $1 >expect &&
  90        git -c core.multiPackIndex=true $1 >actual &&
  91        if [ "$2" = "sorted" ]
  92        then
  93                sort <expect >expect.sorted &&
  94                mv expect.sorted expect &&
  95                sort <actual >actual.sorted &&
  96                mv actual.sorted actual
  97        fi &&
  98        test_cmp expect actual
  99}
 100
 101compare_results_with_midx () {
 102        MSG=$1
 103        test_expect_success "check normal git operations: $MSG" '
 104                midx_git_two_modes "rev-list --objects --all" &&
 105                midx_git_two_modes "log --raw" &&
 106                midx_git_two_modes "count-objects --verbose" &&
 107                midx_git_two_modes "cat-file --batch-all-objects --batch-check" &&
 108                midx_git_two_modes "cat-file --batch-all-objects --batch-check --unordered" sorted
 109        '
 110}
 111
 112test_expect_success 'write midx with one v2 pack' '
 113        git pack-objects --index-version=2,0x40 $objdir/pack/test <obj-list &&
 114        git multi-pack-index --object-dir=$objdir write &&
 115        midx_read_expect 1 18 4 $objdir
 116'
 117
 118compare_results_with_midx "one v2 pack"
 119
 120test_expect_success 'corrupt idx not opened' '
 121        idx=$(test-tool read-midx $objdir | grep "\.idx\$") &&
 122        mv $objdir/pack/$idx backup-$idx &&
 123        test_when_finished "mv backup-\$idx \$objdir/pack/\$idx" &&
 124
 125        # This is the minimum size for a sha-1 based .idx; this lets
 126        # us pass perfunctory tests, but anything that actually opens and reads
 127        # the idx file will complain.
 128        test_copy_bytes 1064 <backup-$idx >$objdir/pack/$idx &&
 129
 130        git -c core.multiPackIndex=true rev-list --objects --all 2>err &&
 131        test_must_be_empty err
 132'
 133
 134test_expect_success 'add more objects' '
 135        for i in $(test_seq 6 10)
 136        do
 137                generate_objects $i
 138        done &&
 139        commit_and_list_objects
 140'
 141
 142test_expect_success 'write midx with two packs' '
 143        git pack-objects --index-version=1 $objdir/pack/test-2 <obj-list &&
 144        git multi-pack-index --object-dir=$objdir write &&
 145        midx_read_expect 2 34 4 $objdir
 146'
 147
 148compare_results_with_midx "two packs"
 149
 150test_expect_success 'add more packs' '
 151        for j in $(test_seq 11 20)
 152        do
 153                generate_objects $j &&
 154                commit_and_list_objects &&
 155                git pack-objects --index-version=2 $objdir/pack/test-pack <obj-list
 156        done
 157'
 158
 159compare_results_with_midx "mixed mode (two packs + extra)"
 160
 161test_expect_success 'write midx with twelve packs' '
 162        git multi-pack-index --object-dir=$objdir write &&
 163        midx_read_expect 12 74 4 $objdir
 164'
 165
 166compare_results_with_midx "twelve packs"
 167
 168test_expect_success 'verify multi-pack-index success' '
 169        git multi-pack-index verify --object-dir=$objdir
 170'
 171
 172# usage: corrupt_midx_and_verify <pos> <data> <objdir> <string>
 173corrupt_midx_and_verify() {
 174        POS=$1 &&
 175        DATA="${2:-\0}" &&
 176        OBJDIR=$3 &&
 177        GREPSTR="$4" &&
 178        COMMAND="$5" &&
 179        if test -z "$COMMAND"
 180        then
 181                COMMAND="git multi-pack-index verify --object-dir=$OBJDIR"
 182        fi &&
 183        FILE=$OBJDIR/pack/multi-pack-index &&
 184        chmod a+w $FILE &&
 185        test_when_finished mv midx-backup $FILE &&
 186        cp $FILE midx-backup &&
 187        printf "$DATA" | dd of="$FILE" bs=1 seek="$POS" conv=notrunc &&
 188        test_must_fail $COMMAND 2>test_err &&
 189        grep -v "^+" test_err >err &&
 190        test_i18ngrep "$GREPSTR" err
 191}
 192
 193test_expect_success 'verify bad signature' '
 194        corrupt_midx_and_verify 0 "\00" $objdir \
 195                "multi-pack-index signature"
 196'
 197
 198HASH_LEN=20
 199NUM_OBJECTS=74
 200MIDX_BYTE_VERSION=4
 201MIDX_BYTE_OID_VERSION=5
 202MIDX_BYTE_CHUNK_COUNT=6
 203MIDX_HEADER_SIZE=12
 204MIDX_BYTE_CHUNK_ID=$MIDX_HEADER_SIZE
 205MIDX_BYTE_CHUNK_OFFSET=$(($MIDX_HEADER_SIZE + 4))
 206MIDX_NUM_CHUNKS=5
 207MIDX_CHUNK_LOOKUP_WIDTH=12
 208MIDX_OFFSET_PACKNAMES=$(($MIDX_HEADER_SIZE + \
 209                         $MIDX_NUM_CHUNKS * $MIDX_CHUNK_LOOKUP_WIDTH))
 210MIDX_BYTE_PACKNAME_ORDER=$(($MIDX_OFFSET_PACKNAMES + 2))
 211MIDX_OFFSET_OID_FANOUT=$(($MIDX_OFFSET_PACKNAMES + 652))
 212MIDX_OID_FANOUT_WIDTH=4
 213MIDX_BYTE_OID_FANOUT_ORDER=$((MIDX_OFFSET_OID_FANOUT + 250 * $MIDX_OID_FANOUT_WIDTH + 1))
 214MIDX_OFFSET_OID_LOOKUP=$(($MIDX_OFFSET_OID_FANOUT + 256 * $MIDX_OID_FANOUT_WIDTH))
 215MIDX_BYTE_OID_LOOKUP=$(($MIDX_OFFSET_OID_LOOKUP + 16 * $HASH_LEN))
 216MIDX_OFFSET_OBJECT_OFFSETS=$(($MIDX_OFFSET_OID_LOOKUP + $NUM_OBJECTS * $HASH_LEN))
 217MIDX_OFFSET_WIDTH=8
 218MIDX_BYTE_PACK_INT_ID=$(($MIDX_OFFSET_OBJECT_OFFSETS + 16 * $MIDX_OFFSET_WIDTH + 2))
 219MIDX_BYTE_OFFSET=$(($MIDX_OFFSET_OBJECT_OFFSETS + 16 * $MIDX_OFFSET_WIDTH + 6))
 220
 221test_expect_success 'verify bad version' '
 222        corrupt_midx_and_verify $MIDX_BYTE_VERSION "\00" $objdir \
 223                "multi-pack-index version"
 224'
 225
 226test_expect_success 'verify bad OID version' '
 227        corrupt_midx_and_verify $MIDX_BYTE_OID_VERSION "\02" $objdir \
 228                "hash version"
 229'
 230
 231test_expect_success 'verify truncated chunk count' '
 232        corrupt_midx_and_verify $MIDX_BYTE_CHUNK_COUNT "\01" $objdir \
 233                "missing required"
 234'
 235
 236test_expect_success 'verify extended chunk count' '
 237        corrupt_midx_and_verify $MIDX_BYTE_CHUNK_COUNT "\07" $objdir \
 238                "terminating multi-pack-index chunk id appears earlier than expected"
 239'
 240
 241test_expect_success 'verify missing required chunk' '
 242        corrupt_midx_and_verify $MIDX_BYTE_CHUNK_ID "\01" $objdir \
 243                "missing required"
 244'
 245
 246test_expect_success 'verify invalid chunk offset' '
 247        corrupt_midx_and_verify $MIDX_BYTE_CHUNK_OFFSET "\01" $objdir \
 248                "invalid chunk offset (too large)"
 249'
 250
 251test_expect_success 'verify packnames out of order' '
 252        corrupt_midx_and_verify $MIDX_BYTE_PACKNAME_ORDER "z" $objdir \
 253                "pack names out of order"
 254'
 255
 256test_expect_success 'verify packnames out of order' '
 257        corrupt_midx_and_verify $MIDX_BYTE_PACKNAME_ORDER "a" $objdir \
 258                "failed to load pack"
 259'
 260
 261test_expect_success 'verify oid fanout out of order' '
 262        corrupt_midx_and_verify $MIDX_BYTE_OID_FANOUT_ORDER "\01" $objdir \
 263                "oid fanout out of order"
 264'
 265
 266test_expect_success 'verify oid lookup out of order' '
 267        corrupt_midx_and_verify $MIDX_BYTE_OID_LOOKUP "\00" $objdir \
 268                "oid lookup out of order"
 269'
 270
 271test_expect_success 'verify incorrect pack-int-id' '
 272        corrupt_midx_and_verify $MIDX_BYTE_PACK_INT_ID "\07" $objdir \
 273                "bad pack-int-id"
 274'
 275
 276test_expect_success 'verify incorrect offset' '
 277        corrupt_midx_and_verify $MIDX_BYTE_OFFSET "\07" $objdir \
 278                "incorrect object offset"
 279'
 280
 281test_expect_success 'git-fsck incorrect offset' '
 282        corrupt_midx_and_verify $MIDX_BYTE_OFFSET "\07" $objdir \
 283                "incorrect object offset" \
 284                "git -c core.multipackindex=true fsck"
 285'
 286
 287test_expect_success 'repack removes multi-pack-index' '
 288        test_path_is_file $objdir/pack/multi-pack-index &&
 289        GIT_TEST_MULTI_PACK_INDEX=0 git repack -adf &&
 290        test_path_is_missing $objdir/pack/multi-pack-index
 291'
 292
 293compare_results_with_midx "after repack"
 294
 295test_expect_success 'multi-pack-index and pack-bitmap' '
 296        git -c repack.writeBitmaps=true repack -ad &&
 297        git multi-pack-index write &&
 298        git rev-list --test-bitmap HEAD
 299'
 300
 301test_expect_success 'multi-pack-index and alternates' '
 302        git init --bare alt.git &&
 303        echo $(pwd)/alt.git/objects >.git/objects/info/alternates &&
 304        echo content1 >file1 &&
 305        altblob=$(GIT_DIR=alt.git git hash-object -w file1) &&
 306        git cat-file blob $altblob &&
 307        git rev-list --all
 308'
 309
 310compare_results_with_midx "with alternate (local midx)"
 311
 312test_expect_success 'multi-pack-index in an alternate' '
 313        mv .git/objects/pack/* alt.git/objects/pack &&
 314        test_commit add_local_objects &&
 315        git repack --local &&
 316        git multi-pack-index write &&
 317        midx_read_expect 1 3 4 $objdir &&
 318        git reset --hard HEAD~1 &&
 319        rm -f .git/objects/pack/*
 320'
 321
 322compare_results_with_midx "with alternate (remote midx)"
 323
 324# usage: corrupt_data <file> <pos> [<data>]
 325corrupt_data () {
 326        file=$1
 327        pos=$2
 328        data="${3:-\0}"
 329        printf "$data" | dd of="$file" bs=1 seek="$pos" conv=notrunc
 330}
 331
 332# Force 64-bit offsets by manipulating the idx file.
 333# This makes the IDX file _incorrect_ so be careful to clean up after!
 334test_expect_success 'force some 64-bit offsets with pack-objects' '
 335        mkdir objects64 &&
 336        mkdir objects64/pack &&
 337        for i in $(test_seq 1 11)
 338        do
 339                generate_objects 11
 340        done &&
 341        commit_and_list_objects &&
 342        pack64=$(git pack-objects --index-version=2,0x40 objects64/pack/test-64 <obj-list) &&
 343        idx64=objects64/pack/test-64-$pack64.idx &&
 344        chmod u+w $idx64 &&
 345        corrupt_data $idx64 2999 "\02" &&
 346        midx64=$(git multi-pack-index --object-dir=objects64 write) &&
 347        midx_read_expect 1 63 5 objects64 " large-offsets"
 348'
 349
 350test_expect_success 'verify multi-pack-index with 64-bit offsets' '
 351        git multi-pack-index verify --object-dir=objects64
 352'
 353
 354NUM_OBJECTS=63
 355MIDX_OFFSET_OID_FANOUT=$((MIDX_OFFSET_PACKNAMES + 54))
 356MIDX_OFFSET_OID_LOOKUP=$((MIDX_OFFSET_OID_FANOUT + 256 * $MIDX_OID_FANOUT_WIDTH))
 357MIDX_OFFSET_OBJECT_OFFSETS=$(($MIDX_OFFSET_OID_LOOKUP + $NUM_OBJECTS * $HASH_LEN))
 358MIDX_OFFSET_LARGE_OFFSETS=$(($MIDX_OFFSET_OBJECT_OFFSETS + $NUM_OBJECTS * $MIDX_OFFSET_WIDTH))
 359MIDX_BYTE_LARGE_OFFSET=$(($MIDX_OFFSET_LARGE_OFFSETS + 3))
 360
 361test_expect_success 'verify incorrect 64-bit offset' '
 362        corrupt_midx_and_verify $MIDX_BYTE_LARGE_OFFSET "\07" objects64 \
 363                "incorrect object offset"
 364'
 365
 366test_done