fix bucket keys as ints format

[Elbehery]

This PR fixes the output format when bucket keys are numbers.

resolves #588

cc @ahrtr

[ahrtr]

If the data isn't an integer, the output of %d might be strange.

Currently the default output format is bytes, I suggest to only change the default format as auto.

[Elbehery]

@ahrtr fixed 👍🏽

[ahrtr]

I meant to change the default format from bytes to auto,

bbolt/cmd/bbolt/main.go

Line 912 in d094cd7

optionsFormat := fs.String("format", "bytes", "Output format. One of: "+FORMAT_MODES+" (default: bytes)")

Please also let's go through the default format for all commands, and decide whether we should change the default format. At least, let's list them firstly.

[Elbehery]

@ahrtr sorry for the delay, i pushed the change now

also found that the usage was displaying incorrectly auto

bbolt/cmd/bbolt/page_command.go

Line 285 in 393e10e

--format-value=`+FORMAT_MODES+` (default: auto)

[Elbehery]

i will go through all the commands now in a separate commit

[ahrtr]

i will go through all the commands now in a separate commit

thx, we can discuss the details on next Monday's meeting.

[Elbehery]

found the following cmds

• List Pages, default auto
• PageItem, default ascii-encoded
• Keys, default bytes
• Get has two default, input default format is ascii-encoded, output default format is bytes

[ahrtr]

found the following cmds

• List Pages, default auto
• PageItem, default ascii-encoded
• Keys, default bytes
• Get has two default, input default format is ascii-encoded, output default format is bytes

I think we should set the default output format as "auto" for all of them. Could you also add test cases to verify the output?

bbolt/cmd/bbolt/main.go

Lines 1580 to 1587 in 2b28986

	func bytesToAsciiOrHex(b []byte) string {
	sb := string(b)
	if isPrintable(sb) {
	return sb
	} else {
	return hex.EncodeToString(b)
	}
	}

Get has two default, input default format is ascii-encoded

Suggest not to change the parse-format.

[Elbehery]

@ahrtr

Could you also add test cases to verify the output?

The func is not exposed, and the main_test.go is in main_test package, not main package .. to add unit test will need to change either the package to main or expose the func bytesToAsciiOrHex and this will change everywhere it is used

Please let me know :)

[ahrtr]

The func is not exposed,

We don't test the function directly. Instead, we test the command, and verify whether the command's output is expected, similar to

bbolt/cmd/bbolt/main_test.go

Line 75 in 2b28986

} else if m.Stdout.String() != exp {

[Elbehery]

@ahrtr Hello ✋🏽

So to test this change, I ran the TestPageItemCommand_Run and it passes.

currently the test case assert the keys and values are being inserted in

bbolt/cmd/bbolt/main_test.go

Lines 143 to 146 in 4154f9c

	err := db.Fill([]byte("data"), 1, 100,
	func(tx int, k int) []byte { return []byte(fmt.Sprintf("key_%d", k)) },
	func(tx int, k int) []byte { return []byte(fmt.Sprintf("value_%d", k)) },
	)

exists within the page, it capture the Main.Stdout as a string here

bbolt/cmd/bbolt/main_test.go

Line 165 in 4154f9c

if !strings.Contains(m.Stdout.String(), "key_0") || !strings.Contains(m.Stdout.String(), "value_0") {

Although the key and value are being inserted are int typed, they are asserted as a string prefix

I am stuck in what should I assert to test the changes ?

I can insert hex data for instance, but still I will capture the output as a string, please correct me if I am wrong ?

[Elbehery]

@ahrtr I added this sub-test

• insert keys in int64 format
• asserting the keys are retrieved correctly

running this test fails on

  --- FAIL: TestKeysCommand_Run/test_keys_in_int_format (0.08s)
        btesting.go:47: Opening bbolt DB at: /var/folders/vh/wkbmyt411316pt46h81d6_300000gn/T/TestKeysCommand_Runtest_keys_in_int_format3069027896/001/db
        btesting.go:87: Closing bbolt DB at: /var/folders/vh/wkbmyt411316pt46h81d6_300000gn/T/TestKeysCommand_Runtest_keys_in_int_format3069027896/001/db
        main_test.go:341: unexpected stdout:
            
            a29c01
            a49c01

[Elbehery]

same here added subtest for string keys and int64 values, similar issue

go test -run TestGetCommand_Run                                                                                                                                        ‹git:fix_bucket_keys_as_ints ✔› 11:34.33 Mon Nov 06 2023 >>> 
--- FAIL: TestGetCommand_Run (0.17s)
    --- FAIL: TestGetCommand_Run/test_values_in_int64_format (0.08s)
        btesting.go:47: Opening bbolt DB at: /var/folders/vh/wkbmyt411316pt46h81d6_300000gn/T/TestGetCommand_Runtest_values_in_int64_format893707620/001/db
        btesting.go:87: Closing bbolt DB at: /var/folders/vh/wkbmyt411316pt46h81d6_300000gn/T/TestGetCommand_Runtest_values_in_int64_format893707620/001/db
        main_test.go:422: unexpected stdout:
            
            a29c01

[Elbehery]

it fails here

         Error:          Should not be: 0

we sat the pageId above to 0 and it is the same as the above subtest !!!

[ahrtr]

I suggest to split this PR into three small PRs, and each of them takes care of one change for one command mentioned in #590 (comment), so as to make the review easier. I will work together with you to resolve them one by one.

What do you think?

[Elbehery]

#590 (comment)

on it :+1

[Elbehery]

@ahrtr raised

• fix: change pageItemCommand default format auto #596
• fix:change keysCommand default format auto #597
• fix: change getCommand default format auto #598

shall we close this ?

[Elbehery]

@ahrtr closing this