development/git
development/git
1
0
Fork 0
mirror of https://github.com/git/git synced 2024-11-05 04:53:18 +00:00
Code Issues Projects Releases Packages Wiki Activity
git/t/t5750-bundle-uri-parse.sh

291 lines
6.7 KiB
Bash
Raw Permalink Normal View History

bundle-uri: unit test "key=value" parsing Create a new 'test-tool bundle-uri' test helper. This helper will assist in testing logic deep in the bundle URI feature. This change introduces the 'parse-key-values' subcommand, which parses an input file as a list of lines. These are fed into bundle_uri_parse_line() to test how we construct a 'struct bundle_list' from that data. The list is then output to stdout as if the key-value pairs were a Git config file. We use an input file instead of stdin because of a future change to parse in config-file format that works better as an input file. Co-authored-by: Derrick Stolee <derrickstolee@github.com> Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com> Signed-off-by: Derrick Stolee <derrickstolee@github.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2022-10-12 12:52:32 +00:00
#!/bin/sh
test_description="Test bundle-uri bundle_uri_parse_line()"
TEST_NO_CREATE_REPO=1
TEST_PASSES_SANITIZE_LEAK=true
. ./test-lib.sh
test_expect_success 'bundle_uri_parse_line() just URIs' '
cat >in <<-\EOF &&
bundle.one.uri=http://example.com/bundle.bdl
bundle.two.uri=https://example.com/bundle.bdl
bundle.three.uri=file:///usr/share/git/bundle.bdl
EOF
cat >expect <<-\EOF &&
[bundle]
version = 1
mode = all
[bundle "one"]
uri = http://example.com/bundle.bdl
[bundle "two"]
uri = https://example.com/bundle.bdl
[bundle "three"]
uri = file:///usr/share/git/bundle.bdl
EOF
test-tool bundle-uri parse-key-values in >actual 2>err &&
test_must_be_empty err &&
test_cmp_config_output expect actual
'
bundle-uri: allow relative URLs in bundle lists Bundle providers may want to distribute that data across multiple CDNs. This might require a change in the base URI, all the way to the domain name. If all bundles require an absolute URI in their 'uri' value, then every push to a CDN would require altering the table of contents to match the expected domain and exact location within it. Allow a bundle list to specify a relative URI for the bundles. This URI is based on where the client received the bundle list. For a list provided in the 'bundle-uri' protocol v2 command, the Git remote URI is the base URI. Otherwise, the bundle list was provided from an HTTP URI not using the Git protocol, and that URI is the base URI. This allows easier distribution of bundle data. Signed-off-by: Derrick Stolee <derrickstolee@github.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2022-12-22 15:14:15 +00:00
test_expect_success 'bundle_uri_parse_line(): relative URIs' '
cat >in <<-\EOF &&
bundle.one.uri=bundle.bdl
bundle.two.uri=../bundle.bdl
bundle.three.uri=sub/dir/bundle.bdl
EOF
cat >expect <<-\EOF &&
[bundle]
version = 1
mode = all
[bundle "one"]
uri = <uri>/bundle.bdl
[bundle "two"]
uri = bundle.bdl
[bundle "three"]
uri = <uri>/sub/dir/bundle.bdl
EOF
test-tool bundle-uri parse-key-values in >actual 2>err &&
test_must_be_empty err &&
test_cmp_config_output expect actual
'
test_expect_success 'bundle_uri_parse_line(): relative URIs and parent paths' '
cat >in <<-\EOF &&
bundle.one.uri=bundle.bdl
bundle.two.uri=../bundle.bdl
bundle.three.uri=../../bundle.bdl
EOF
cat >expect <<-\EOF &&
[bundle]
version = 1
mode = all
[bundle "one"]
uri = <uri>/bundle.bdl
[bundle "two"]
uri = bundle.bdl
[bundle "three"]
uri = <uri>/../bundle.bdl
EOF
# TODO: We would prefer if parsing a bundle list would not cause
# a die() and instead would give a warning and allow the rest of
# a Git command to continue. This test_must_fail is necessary for
# now until the interface for relative_url() allows for reporting
# an error instead of die()ing.
test_must_fail test-tool bundle-uri parse-key-values in >actual 2>err &&
grep "fatal: cannot strip one component off url" err
'
bundle-uri: unit test "key=value" parsing Create a new 'test-tool bundle-uri' test helper. This helper will assist in testing logic deep in the bundle URI feature. This change introduces the 'parse-key-values' subcommand, which parses an input file as a list of lines. These are fed into bundle_uri_parse_line() to test how we construct a 'struct bundle_list' from that data. The list is then output to stdout as if the key-value pairs were a Git config file. We use an input file instead of stdin because of a future change to parse in config-file format that works better as an input file. Co-authored-by: Derrick Stolee <derrickstolee@github.com> Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com> Signed-off-by: Derrick Stolee <derrickstolee@github.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2022-10-12 12:52:32 +00:00
test_expect_success 'bundle_uri_parse_line() parsing edge cases: empty key or value' '
cat >in <<-\EOF &&
=bogus-value
bogus-key=
EOF
cat >err.expect <<-EOF &&
error: bundle-uri: line has empty key or value
error: bad line: '\''=bogus-value'\''
error: bundle-uri: line has empty key or value
error: bad line: '\''bogus-key='\''
EOF
cat >expect <<-\EOF &&
[bundle]
version = 1
mode = all
EOF
test_must_fail test-tool bundle-uri parse-key-values in >actual 2>err &&
test_cmp err.expect err &&
test_cmp_config_output expect actual
'
test_expect_success 'bundle_uri_parse_line() parsing edge cases: empty lines' '
cat >in <<-\EOF &&
bundle.one.uri=http://example.com/bundle.bdl
bundle.two.uri=https://example.com/bundle.bdl
bundle.three.uri=file:///usr/share/git/bundle.bdl
EOF
cat >err.expect <<-\EOF &&
error: bundle-uri: got an empty line
error: bad line: '\'''\''
error: bundle-uri: got an empty line
error: bad line: '\'''\''
EOF
# We fail, but try to continue parsing regardless
cat >expect <<-\EOF &&
[bundle]
version = 1
mode = all
[bundle "one"]
uri = http://example.com/bundle.bdl
[bundle "two"]
uri = https://example.com/bundle.bdl
[bundle "three"]
uri = file:///usr/share/git/bundle.bdl
EOF
test_must_fail test-tool bundle-uri parse-key-values in >actual 2>err &&
test_cmp err.expect err &&
test_cmp_config_output expect actual
'
test_expect_success 'bundle_uri_parse_line() parsing edge cases: duplicate lines' '
cat >in <<-\EOF &&
bundle.one.uri=http://example.com/bundle.bdl
bundle.two.uri=https://example.com/bundle.bdl
bundle.one.uri=https://example.com/bundle-2.bdl
bundle.three.uri=file:///usr/share/git/bundle.bdl
EOF
cat >err.expect <<-\EOF &&
error: bad line: '\''bundle.one.uri=https://example.com/bundle-2.bdl'\''
EOF
# We fail, but try to continue parsing regardless
cat >expect <<-\EOF &&
[bundle]
version = 1
mode = all
[bundle "one"]
uri = http://example.com/bundle.bdl
[bundle "two"]
uri = https://example.com/bundle.bdl
[bundle "three"]
uri = file:///usr/share/git/bundle.bdl
EOF
test_must_fail test-tool bundle-uri parse-key-values in >actual 2>err &&
test_cmp err.expect err &&
test_cmp_config_output expect actual
'
bundle-uri: parse bundle list in config format When a bundle provider wants to operate independently from a Git remote, they want to provide a single, consistent URI that users can use in their 'git clone --bundle-uri' commands. At this point, the Git client expects that URI to be a single bundle that can be unbundled and used to bootstrap the rest of the clone from the Git server. This single bundle cannot be re-used to assist with future incremental fetches. To allow for the incremental fetch case, teach Git to understand a bundle list that could be advertised at an independent bundle URI. Such a bundle list is likely to be inspected by human readers, even if only by the bundle provider creating the list. For this reason, we can take our expected "key=value" pairs and instead format them using Git config format. Create bundle_uri_parse_config_format() to parse a file in config format and convert that into a 'struct bundle_list' filled with its understanding of the contents. Be careful to use error_action CONFIG_ERROR_ERROR when calling git_config_from_file_with_options() because the default action for git_config_from_file() is to die() on a parsing error. The current warning isn't particularly helpful if it arises to a user, but it will be made more verbose at a higher layer later. Update 'test-tool bundle-uri' to take this config file format as input. It uses a filename instead of stdin because there is no existing way to parse a FILE pointer in the config machinery. Using git_config_from_mem() is overly complicated and more likely to introduce bugs than this simpler version. Signed-off-by: Derrick Stolee <derrickstolee@github.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2022-10-12 12:52:33 +00:00
test_expect_success 'parse config format: just URIs' '
cat >expect <<-\EOF &&
[bundle]
version = 1
mode = all
[bundle "one"]
uri = http://example.com/bundle.bdl
[bundle "two"]
uri = https://example.com/bundle.bdl
[bundle "three"]
uri = file:///usr/share/git/bundle.bdl
EOF
test-tool bundle-uri parse-config expect >actual 2>err &&
test_must_be_empty err &&
test_cmp_config_output expect actual
'
bundle-uri: allow relative URLs in bundle lists Bundle providers may want to distribute that data across multiple CDNs. This might require a change in the base URI, all the way to the domain name. If all bundles require an absolute URI in their 'uri' value, then every push to a CDN would require altering the table of contents to match the expected domain and exact location within it. Allow a bundle list to specify a relative URI for the bundles. This URI is based on where the client received the bundle list. For a list provided in the 'bundle-uri' protocol v2 command, the Git remote URI is the base URI. Otherwise, the bundle list was provided from an HTTP URI not using the Git protocol, and that URI is the base URI. This allows easier distribution of bundle data. Signed-off-by: Derrick Stolee <derrickstolee@github.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2022-12-22 15:14:15 +00:00
test_expect_success 'parse config format: relative URIs' '
cat >in <<-\EOF &&
[bundle]
version = 1
mode = all
[bundle "one"]
uri = bundle.bdl
[bundle "two"]
uri = ../bundle.bdl
[bundle "three"]
uri = sub/dir/bundle.bdl
EOF
cat >expect <<-\EOF &&
[bundle]
version = 1
mode = all
[bundle "one"]
uri = <uri>/bundle.bdl
[bundle "two"]
uri = bundle.bdl
[bundle "three"]
uri = <uri>/sub/dir/bundle.bdl
EOF
test-tool bundle-uri parse-config in >actual 2>err &&
test_must_be_empty err &&
test_cmp_config_output expect actual
'
bundle-uri: parse bundle list in config format When a bundle provider wants to operate independently from a Git remote, they want to provide a single, consistent URI that users can use in their 'git clone --bundle-uri' commands. At this point, the Git client expects that URI to be a single bundle that can be unbundled and used to bootstrap the rest of the clone from the Git server. This single bundle cannot be re-used to assist with future incremental fetches. To allow for the incremental fetch case, teach Git to understand a bundle list that could be advertised at an independent bundle URI. Such a bundle list is likely to be inspected by human readers, even if only by the bundle provider creating the list. For this reason, we can take our expected "key=value" pairs and instead format them using Git config format. Create bundle_uri_parse_config_format() to parse a file in config format and convert that into a 'struct bundle_list' filled with its understanding of the contents. Be careful to use error_action CONFIG_ERROR_ERROR when calling git_config_from_file_with_options() because the default action for git_config_from_file() is to die() on a parsing error. The current warning isn't particularly helpful if it arises to a user, but it will be made more verbose at a higher layer later. Update 'test-tool bundle-uri' to take this config file format as input. It uses a filename instead of stdin because there is no existing way to parse a FILE pointer in the config machinery. Using git_config_from_mem() is overly complicated and more likely to introduce bugs than this simpler version. Signed-off-by: Derrick Stolee <derrickstolee@github.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2022-10-12 12:52:33 +00:00
test_expect_success 'parse config format edge cases: empty key or value' '
cat >in1 <<-\EOF &&
= bogus-value
EOF
cat >err1 <<-EOF &&
error: bad config line 1 in file in1
EOF
cat >expect <<-\EOF &&
[bundle]
version = 1
mode = all
EOF
test_must_fail test-tool bundle-uri parse-config in1 >actual 2>err &&
test_cmp err1 err &&
test_cmp_config_output expect actual &&
cat >in2 <<-\EOF &&
bogus-key =
EOF
cat >err2 <<-EOF &&
error: bad config line 1 in file in2
EOF
test_must_fail test-tool bundle-uri parse-config in2 >actual 2>err &&
test_cmp err2 err &&
test_cmp_config_output expect actual
'
bundle-uri: parse bundle.heuristic=creationToken The bundle.heuristic value communicates that the bundle list is organized to make use of the bundle.<id>.creationToken values that may be provided in the bundle list. Those values will create a total order on the bundles, allowing the Git client to download them in a specific order and even remember previously-downloaded bundles by storing the maximum creation token value. Before implementing any logic that parses or uses the bundle.<id>.creationToken values, teach Git to parse the bundle.heuristic value from a bundle list. We can use 'test-tool bundle-uri' to print the heuristic value and verify that the parsing works correctly. As an extra precaution, create the internal 'heuristics' array to be a list of (enum, string) pairs so we can iterate through the array entries carefully, regardless of the enum values. Signed-off-by: Derrick Stolee <derrickstolee@github.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2023-01-31 13:29:12 +00:00
test_expect_success 'parse config format: creationToken heuristic' '
cat >expect <<-\EOF &&
[bundle]
version = 1
mode = all
heuristic = creationToken
[bundle "one"]
uri = http://example.com/bundle.bdl
bundle-uri: parse bundle.<id>.creationToken values The previous change taught Git to parse the bundle.heuristic value, especially when its value is "creationToken". Now, teach Git to parse the bundle.<id>.creationToken values on each bundle in a bundle list. Before implementing any logic based on creationToken values for the creationToken heuristic, parse and print these values for testing purposes. Signed-off-by: Derrick Stolee <derrickstolee@github.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2023-01-31 13:29:13 +00:00
creationToken = 123456
bundle-uri: parse bundle.heuristic=creationToken The bundle.heuristic value communicates that the bundle list is organized to make use of the bundle.<id>.creationToken values that may be provided in the bundle list. Those values will create a total order on the bundles, allowing the Git client to download them in a specific order and even remember previously-downloaded bundles by storing the maximum creation token value. Before implementing any logic that parses or uses the bundle.<id>.creationToken values, teach Git to parse the bundle.heuristic value from a bundle list. We can use 'test-tool bundle-uri' to print the heuristic value and verify that the parsing works correctly. As an extra precaution, create the internal 'heuristics' array to be a list of (enum, string) pairs so we can iterate through the array entries carefully, regardless of the enum values. Signed-off-by: Derrick Stolee <derrickstolee@github.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2023-01-31 13:29:12 +00:00
[bundle "two"]
uri = https://example.com/bundle.bdl
bundle-uri: parse bundle.<id>.creationToken values The previous change taught Git to parse the bundle.heuristic value, especially when its value is "creationToken". Now, teach Git to parse the bundle.<id>.creationToken values on each bundle in a bundle list. Before implementing any logic based on creationToken values for the creationToken heuristic, parse and print these values for testing purposes. Signed-off-by: Derrick Stolee <derrickstolee@github.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2023-01-31 13:29:13 +00:00
creationToken = 12345678901234567890
bundle-uri: parse bundle.heuristic=creationToken The bundle.heuristic value communicates that the bundle list is organized to make use of the bundle.<id>.creationToken values that may be provided in the bundle list. Those values will create a total order on the bundles, allowing the Git client to download them in a specific order and even remember previously-downloaded bundles by storing the maximum creation token value. Before implementing any logic that parses or uses the bundle.<id>.creationToken values, teach Git to parse the bundle.heuristic value from a bundle list. We can use 'test-tool bundle-uri' to print the heuristic value and verify that the parsing works correctly. As an extra precaution, create the internal 'heuristics' array to be a list of (enum, string) pairs so we can iterate through the array entries carefully, regardless of the enum values. Signed-off-by: Derrick Stolee <derrickstolee@github.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2023-01-31 13:29:12 +00:00
[bundle "three"]
uri = file:///usr/share/git/bundle.bdl
bundle-uri: parse bundle.<id>.creationToken values The previous change taught Git to parse the bundle.heuristic value, especially when its value is "creationToken". Now, teach Git to parse the bundle.<id>.creationToken values on each bundle in a bundle list. Before implementing any logic based on creationToken values for the creationToken heuristic, parse and print these values for testing purposes. Signed-off-by: Derrick Stolee <derrickstolee@github.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2023-01-31 13:29:13 +00:00
creationToken = 1
bundle-uri: parse bundle.heuristic=creationToken The bundle.heuristic value communicates that the bundle list is organized to make use of the bundle.<id>.creationToken values that may be provided in the bundle list. Those values will create a total order on the bundles, allowing the Git client to download them in a specific order and even remember previously-downloaded bundles by storing the maximum creation token value. Before implementing any logic that parses or uses the bundle.<id>.creationToken values, teach Git to parse the bundle.heuristic value from a bundle list. We can use 'test-tool bundle-uri' to print the heuristic value and verify that the parsing works correctly. As an extra precaution, create the internal 'heuristics' array to be a list of (enum, string) pairs so we can iterate through the array entries carefully, regardless of the enum values. Signed-off-by: Derrick Stolee <derrickstolee@github.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2023-01-31 13:29:12 +00:00
EOF
test-tool bundle-uri parse-config expect >actual 2>err &&
test_must_be_empty err &&
test_cmp_config_output expect actual
'
bundle-uri: parse bundle.<id>.creationToken values The previous change taught Git to parse the bundle.heuristic value, especially when its value is "creationToken". Now, teach Git to parse the bundle.<id>.creationToken values on each bundle in a bundle list. Before implementing any logic based on creationToken values for the creationToken heuristic, parse and print these values for testing purposes. Signed-off-by: Derrick Stolee <derrickstolee@github.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2023-01-31 13:29:13 +00:00
test_expect_success 'parse config format edge cases: creationToken heuristic' '
cat >expect <<-\EOF &&
[bundle]
version = 1
mode = all
heuristic = creationToken
[bundle "one"]
uri = http://example.com/bundle.bdl
creationToken = bogus
EOF
test-tool bundle-uri parse-config expect >actual 2>err &&
grep "could not parse bundle list key creationToken with value '\''bogus'\''" err
'
bundle-uri: unit test "key=value" parsing Create a new 'test-tool bundle-uri' test helper. This helper will assist in testing logic deep in the bundle URI feature. This change introduces the 'parse-key-values' subcommand, which parses an input file as a list of lines. These are fed into bundle_uri_parse_line() to test how we construct a 'struct bundle_list' from that data. The list is then output to stdout as if the key-value pairs were a Git config file. We use an input file instead of stdin because of a future change to parse in config-file format that works better as an input file. Co-authored-by: Derrick Stolee <derrickstolee@github.com> Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com> Signed-off-by: Derrick Stolee <derrickstolee@github.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2022-10-12 12:52:32 +00:00
test_done
Reference in a new issue Copy permalink