Each do*() method in the cbt parses its own arguments and constructs the appropriate call to the service. It would be nice to refactor these methods to use an argument struct that is composed by another function that only parses arguments.

Why to do this:

• In some cases, the current situation results in a lot of duplicated call (e.g. doLookup() and doRead()).
• Each do*() method has multiple concerns--arg parsing and composing the calls to the service. This breaks the principle of orthogonality.

Is your feature request related to a problem? Please describe.

Starting with version 0.12.0, the cbt CLI can format certain complex types of data stored in table rows. When you use the cbt read or cbt lookup command, the cbt tool can "pretty print" values stored in the rows.
https://cloud.google.com/bigtable/docs/cbt-formatting

from https://github.com/googleapis/cloud-bigtable-cbt-cli/pull/28/files, cbt read and cbt lookup is able to decode BigEndian Int64 with a format file.

BigEndian Int64 and UTF8 string are two popular value types. However, cbt set still only able to set value as UTF8 string.

Describe the solution you'd like

similar to cbt read or cbt lookup, we can improve cbt set to support format file and encode properly.

Describe alternatives you've considered

If it is easy to generalize, it would be nice if cbt set can also support full data types, e.g. Hexadecimal, JSON, Protobuf

Additional context
cbt was quite useful in setup instance/table/column_family in Bigtable emulator (used in development or test environment)
. I have seen a lot use cases where producer and consumer are different applications and mostly implement in different languages.

since cbt is not able to set BigEndian Int64, currently a workaround is to use client SDK to mock data in CI of Consumer applications. It would be more convenient if cbt set can also

Allstar has detected that this repository’s Branch Protection security policy is out of compliance. Status:
Branch Protection enforcement is configured in Allstar, however Branch Protection is not available on this repository. Upgrade to GitHub Pro or make this repository public to enable this feature.
See: https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches for more information.
If this is not feasible, then disable Branch Protection policy enforcement for this repository in Allstar configuration.

This issue will auto resolve when the policy is in compliance.

Issue created by Allstar. See https://github.com/ossf/allstar/ for more information. For questions specific to the repository, please contact the owner or maintainer.

I will update this issue with the link on cloud.google.com once the official formatting documentation is published.

Content to be removed here.

Allstar has detected that this repository’s SECURITY.md security policy is out of compliance. Status:
Security policy not enabled.
A SECURITY.md file can give users information about what constitutes a vulnerability and how to report one securely so that information about a bug is not publicly visible. Examples of secure reporting methods include using an issue tracker with private issue support, or encrypted email with a published key.

To fix this, add a SECURITY.md file that explains how to handle vulnerabilities found in your repository. Go to https://github.com/googlestaging/cloud-bigtable-cli/security/policy to enable.

For more information, see https://docs.github.com/en/code-security/getting-started/adding-a-security-policy-to-your-repository.

This issue will auto resolve when the policy is in compliance.

Issue created by Allstar. See https://github.com/ossf/allstar/ for more information. For questions specific to the repository, please contact the owner or maintainer.

Currently we support reading the configured Cloud Bigtable project from gcloud.

We should also support reading the api_endpoint_overrides/bigtable and api_endpoint_overrides/bigtableadmin values, if specified in gcloud configuration.

See https://cloud.google.com/bigtable/docs/regional-endpoints#how-to for a case where this would be useful.

Allstar has detected that this repository’s Outside Collaborators security policy is out of compliance. Status:
Did not find any owners of this repository
This policy requires all repositories to have an organization member or team assigned as an administrator. Either there are no administrators, or all administrators are outside collaborators. A responsible party is required by organization policy to respond to security events and organization requests.

To add an administrator From the main page of the repository, go to Settings -> Manage Access.
(For more information, see https://docs.github.com/en/organizations/managing-access-to-your-organizations-repositories)

Alternately, if this repository does not have any maintainers, archive or delete it.

This issue will auto resolve when the policy is in compliance.

Issue created by Allstar. See https://github.com/ossf/allstar/ for more information. For questions specific to the repository, please contact the owner or maintainer.

This test failed!

To configure my behavior, see the Flaky Bot documentation.

If I'm commenting on this issue too often, add the flakybot: quiet label and
I will stop commenting.

commit: a71b81d
buildURL: Build Status, Sponge
status: failed

    valueformatting_test.go:569: Formatting printed incorrectly:
        wanted
        ----------------------------------------
        r1
          f1:c1                                    @ 1969/12/31-16:00:00.000000
            "Hello!"
          f1:c2                                    @ 1969/12/31-16:00:00.000000
            "\x01\x02"
          f2:person                                @ 1969/12/31-16:00:00.000000
            "\n\x03Jim\x10*\x1a\[email protected]\"\f\n\b555-1212\x10\x01"
        ,
        got
        ----------------------------------------
        r1
          f1:c1                                    @ 1970/01/01-00:00:00.000000
            "Hello!"
          f1:c2                                    @ 1970/01/01-00:00:00.000000
            "\x01\x02"
          f2:person                                @ 1970/01/01-00:00:00.000000
            "\n\x03Jim\x10*\x1a\[email protected]\"\f\n\b555-1212\x10\x01"

Is your feature request related to a problem? Please describe.

I was trying to test how BigTable behaves when you send a zero cells-per-row row filter and reached for cbt read to construct a request but it didn't have the option.

Describe the solution you'd like

cbt read cells-per-column=n

Describe alternatives you've considered

Hand-rolling the request myself using the SDK.

This test failed!

To configure my behavior, see the Flaky Bot documentation.

If I'm commenting on this issue too often, add the flakybot: quiet label and
I will stop commenting.

commit: 2be564b
buildURL: Build Status, Sponge
status: failed

    valueformatting_test.go:584: Formatting printed incorrectly: wanted
        ----------------------------------------
        r1
          f1:json
            age:   2.00
            name: "Brave"
        ,
        got
        ----------------------------------------
        r1
          f1:json
        age:     2.00
        name:   "Brave"
    
    </pre></details>

Is your feature request related to a problem? Please describe.
I need to view data that is in bytes. cloud-bigtable-cbt-cli recently merged a PR (#28) that allowed a user to specify the encoding used when displaying byte data. This allows me to properly view the column values, but unfortunately the row key is still encoded in what I believe is UTF-8.

Describe the solution you'd like
I would love to be able to display the column values and the row key with the same encoding.

Describe alternatives you've considered
I've considered making a separate CLI tool that takes a row key and displays the data however I want, but the team loves CBT CLI for all of its other features and does not want to be switching back and forth between a custom CLI tool and CBT CLI.

Additional context

As you can see I can correctly read the column data, but row key (B?G???A?'?8???K?) isn't legible.

Some customers encode their cell values as avro. It would be nice to support avro alongside protobuf.

See b/224602935

Unzipping the main code and trying to install from that package fails with the following error:

Error: cbt.go:41:2: missing go.sum entry for module providing package cloud.google.com/go/bigtable (imported by cloud.google.com/go/cbt); to add:
	go get cloud.google.com/go/cbt

It seems like a dependency got updated in go.mod but not in go.sum?

Steps to reproduce

curl -LO https://github.com/googleapis/cloud-bigtable-cbt-cli/archive/refs/heads/main.zip
unzip main.zip
cd cloud-bigtable-cbt-cli-main && go build .

Describe the solution you'd like

I'd like properties of type proto.Any to be recursively unpacked when formatting the cell values serialized in protobuf.

For example, I have the a cell value serialized using the following schema:

import "google/protobuf/any.proto";
message Foo {
   string id = 1;
   google.protobuf.Any bar = 2;
}

message Bar {
   string baz = 1;
}

When writing to Bigtable I set the value of bar with Any.pack on an instance of Bar. Then I try to inspect the content of the cell. I have all the proto files included in the format-file .

At the moment I get:

id: "123"
bar:
  type_url: "type.googleapis.com/Bar" value: "..."

I'd like cbt to unpack the value to the type specified under "type_url"

Additional context
For comparison, grpcurl is able to identify and unpack proto.Any as long as the type is one of the files added with -import-path and -proto: source?

Related:
googleapis/google-cloud-go#6124

Environment details

• OS: Any (tested macOs)
• Package version: v0.12.0

Steps to reproduce

1. Run command go install cloud.google.com/go/bigtable/cmd/loadtest@main

Expected behavior

Install succeeds.

Actual behavior

Install fails because of dependency on cbt.

The Snapshot feature has been replaced with Backups. Access to Snapshots needs to be removed from cbt:

1. Provide warning message to user when accessing feature.
2. (After some time) Remove feature from cbt

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Edited/Blocked

These updates have been manually edited so Renovate will no longer make changes. To discard all commits and start over, click on a checkbox.

• fix(deps): update module gopkg.in/yaml.v2 to v3

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• fix(deps): update module golang.org/x/oauth2 to v0.20.0
• fix(deps): update module golang.org/x/sys to v0.20.0

Detected dependencies

• Check this box to trigger a request for Renovate to run again on this repository

Use something like this: https://github.com/google/go-licenses to ensure that licenses are upto date on presubmit

Policy Bot found one or more issues with this repository.

• Default branch is 'main'
• Branch protection is enabled
• Renovate bot is enabled
• Merge commits disabled
• There is a CODEOWNERS file
• There is a valid LICENSE.md
• There is a CODE_OF_CONDUCT.md
• There is a CONTRIBUTING.md
• There is a SECURITY.md

Right now the cbt tool doesn't have robust unit tests for individual CLI functions (doLookup(), doRead(), etc). These functions should have some tests attached to them:

• Encapsulate all of the functions inside of a struct that can be mocked.
• Add a dependency to the gomock framework.
• Add a go:generate statement that updates the cbt mock structs.
• Add tests for each method in the CBT that uses the mock frameworks.

The documentation for the keys-only option for cbt read says:

keys-only=<true|false>              Whether to print only row keys

However this isn't what it does. It prints all the columns, too. Really this option should be named strip-values, to mirror what the underlying BT API request does.

If I run cbt -instance=abc_123 ls I get an error message which does not help me diagnose my problem. I get:

$ cbt  -instance=abc_123 ls
2023/05/02 15:18:54 -creds flag unset, will use gcloud credential
2023/05/02 15:18:54 -project flag unset, will use gcloud active project
2023/05/02 15:18:54 gcloud active project is "autonomous-mote-782"
2023/05/02 15:18:54 Getting list of tables: rpc error: code = InvalidArgument desc = When parsing 'projects/autonomous-mote-782/instances/abc_123' : Instance name expected in the form 'projects/<project_id>/instances/<instance_id>'.
error details: name = DebugInfo detail = [ORIGINAL ERROR] generic::invalid_argument: When parsing 'projects/autonomous-mote-782/instances/abc_123' : Instance name expected in the form 'projects/<project_id>/instances/<instance_id>'. [google.rpc.error_details_ext] { message: "When parsing \'projects/autonomous-mote-782/instances/abc_123\' : Instance name expected in the form \'projects/<project_id>/instances/<instance_id>\'." } stack =

"Instance name expected in the form 'projects/<project_id>/instances/<instance_id>'" is very confusing since my instance name seemingly does match this pattern.

Conversely, if I do cbt -instance=abc ls, I get a better error message explaining what is wrong:

$ cbt  -instance=abc ls
2023/05/02 15:18:46 -creds flag unset, will use gcloud credential
2023/05/02 15:18:46 -project flag unset, will use gcloud active project
2023/05/02 15:18:47 gcloud active project is "autonomous-mote-782"
2023/05/02 15:18:47 Getting list of tables: rpc error: code = InvalidArgument desc = When parsing 'projects/autonomous-mote-782/instances/abc' : Invalid id for collection instances : Length should be between [6,33], but found 3 'abc'
error details: name = DebugInfo detail = [ORIGINAL ERROR] generic::invalid_argument: When parsing 'projects/autonomous-mote-782/instances/abc' : Invalid id for collection instances : Length should be between [6,33], but found 3 'abc' [google.rpc.error_details_ext] { message: "When parsing \'projects/autonomous-mote-782/instances/abc\' : Invalid id for collection instances : Length should be between [6,33], but found 3 \'abc\'" } stack =

It would be nice if the CLI told me why the instance name was unparseable or at least show me the regex which my instance ID needs to match.

Thanks for stopping by to let us know something could be better!

PLEASE READ: If you have a support contract with Google, please create an issue in the support console instead of filing on GitHub. This will ensure a timely response.

Is your feature request related to a problem? Please describe.
When I use ProtocolBuffer encoding, I'm frustrated by string value encoded in unreadable bytes.
For example, a Korean string "경동나비엔" is printed as "\352\262\275\353\217\231\353\202\230\353\271\204\354\227\224".

Describe the solution you'd like
I would like cbt to support UTF-8 string in read or lookup output.

Describe alternatives you've considered
I found that the unreadable byte sequence is from message.MarshalTextIndent()(link). If we use message.MarshalJSONIndent() instead, a UTF-8 string can be correctly printed like "경동나비엔". So it would be also good if cbt allows users to choose prototext or protojson as the output format. Then prototext will still output bytes in octal, but I can choose protojson to see UTF-string.

Additional context