Skip to content

Improve workspace import command by allowing references to local files for content - #793

Merged
shreyas-goenka merged 6 commits into
mainfrom
improve-improt
Oct 5, 2023
Merged

Improve workspace import command by allowing references to local files for content#793
shreyas-goenka merged 6 commits into
mainfrom
improve-improt

Conversation

@shreyas-goenka

@shreyas-goenkashreyas-goenka commented Sep 25, 2023

Copy link
Copy Markdown
Contributor

Changes

This PR makes a few really important QOL improvements to the workspace import command.

They are:

  1. Adds the --file flag, which allows a user to specify a file to read the content from.
  2. Wraps the most common error first time users of this command will run into with a helpful hint.
  3. Minor changes to the command Use string changing PATH -> TARGET_PATH

Tests

Integration tests. The newly added integration tests that check the --file flag works as expected for both SOURCE and AUTO format.

Skipped the other formats because the API behaviour for them is straightforward.

@shreyas-goenka
shreyas-goenka marked this pull request as ready for review September 25, 2023 00:02
pietern
pietern reviewed Sep 26, 2023
View reviewed changes
Comment threadcmd/workspace/workspace/overrides.go Outdated
Comment threadcmd/workspace/workspace/overrides.go
andrewnester
andrewnester reviewed Oct 5, 2023
View reviewed changes
Comment threadcmd/workspace/workspace/overrides.go
// Give better errors / hints for common API errors.
func wrapImportAPIErrors(err error, importReq *workspace.Import) error {
apiErr := &apierr.APIError{}
if !errors.As(err, &apiErr) {

@andrewnesterandrewnesterOct 5, 2023

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It seems like in the end it checks that the error type is **apierr.APIError instead of apierr.APIError or *apierr.APIError, is it expected?

@shreyas-goenkashreyas-goenkaOct 5, 2023•
edited
Loading

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes. This checks that the error type is *apierr.APIErr. The errors.As method requires a pointer to a type that implements error (ie the Error() method)

In the Go SDK this is done by *apierr.API hence the double pointer being passed. see: https://github.com/databricks/databricks-sdk-go/blob/410c4b0a4cd0c38e97d8e5e3de7ddc2785fd9d12/apierr/errors.go#L65

andrewnester
andrewnester approved these changes Oct 5, 2023
View reviewed changes
Comment threadcmd/workspace/workspace/overrides.go Outdated
@shreyas-goenka
shreyas-goenka added this pull request to the merge queueOct 5, 2023
Merged via the queue into main with commit caade73Oct 5, 2023
@shreyas-goenka
shreyas-goenka deleted the improve-improt branch October 5, 2023 12:56
andrewnester added a commit that referenced this pull request Oct 11, 2023
@andrewnester
Release v0.207.1
8024968
CLI:
* Improve `workspace import` command by allowing references to local files for content ([#793](#793)).
* Add `--file` flag to workspace export command ([#794](#794)).
* Ensure profile flag is respected for sync command ([#837](#837)).
* Add hint to delete sync snapshot if parsing fails ([#853](#853)).
* Use profile information when getting a token using the CLI ([#855](#855)).
Bundles:
* Minor template tweaks ([#832](#832)).
* Fixed using repo files as pipeline libraries ([#847](#847)).
* Support .gitignore syntax in sync section and make sure it works recursively ([#854](#854)).
* Allow target overrides for sync section ([#856](#856)).
Internal:
* Fix import export integration tests on windows ([#842](#842)).
* Fix workspace import test ([#844](#844)).
* Automatically create a release PR in homebrew-tap repo ([#841](#841)).
Dependency updates:
* Bump golang.org/x/term from 0.12.0 to 0.13.0 ([#852](#852)).
* Bump golang.org/x/mod from 0.12.0 to 0.13.0 ([#851](#851)).
* Bump golang.org/x/sync from 0.3.0 to 0.4.0 ([#849](#849)).
* Bump golang.org/x/oauth2 from 0.12.0 to 0.13.0 ([#850](#850)).
@andrewnesterandrewnester mentioned this pull request Oct 11, 2023
Merged
github-merge-queueBot pushed a commit that referenced this pull request Oct 11, 2023
@andrewnester
Release v0.207.1 (#860)
420a01e
CLI:
* Improve `workspace import` command by allowing references to local
files for content ([#793](#793)).
* Add `--file` flag to workspace export command
([#794](#794)).
* Ensure profile flag is respected for sync command
([#837](#837)).
* Add hint to delete sync snapshot if parsing fails
([#853](#853)).
* Use profile information when getting a token using the CLI
([#855](#855)).
Bundles:
* Minor template tweaks
([#832](#832)).
* Fixed using repo files as pipeline libraries
([#847](#847)).
* Support .gitignore syntax in sync section and make sure it works
recursively ([#854](#854)).
* Allow target overrides for sync section
([#856](#856)).
Internal:
* Fix import export integration tests on windows
([#842](#842)).
* Fix workspace import test
([#844](#844)).
* Automatically create a release PR in homebrew-tap repo
([#841](#841)).
Dependency updates:
* Bump golang.org/x/term from 0.12.0 to 0.13.0
([#852](#852)).
* Bump golang.org/x/mod from 0.12.0 to 0.13.0
([#851](#851)).
* Bump golang.org/x/sync from 0.3.0 to 0.4.0
([#849](#849)).
* Bump golang.org/x/oauth2 from 0.12.0 to 0.13.0
([#850](#850)).
hectorcast-db pushed a commit that referenced this pull request Oct 13, 2023
@shreyas-goenka@hectorcast-db
Improve workspace import command by allowing references to local fi…
7df6215
…les for content (#793)
## Changes
This PR makes a few really important QOL improvements to the `workspace
import` command.
They are:
1. Adds the `--file` flag, which allows a user to specify a file to read
the content from.
2. Wraps the most common error first time users of this command will run
into with a helpful hint.
3. Minor changes to the command Use string changing `PATH` ->
`TARGET_PATH`
## Tests
Integration tests. The newly added integration tests that check the
--file flag works as expected for both `SOURCE` and `AUTO` format.
Skipped the other formats because the API behaviour for them is
straightforward.
hectorcast-db pushed a commit that referenced this pull request Oct 13, 2023
@andrewnester@hectorcast-db
Release v0.207.1 (#860)
c35b207
CLI:
* Improve `workspace import` command by allowing references to local
files for content ([#793](#793)).
* Add `--file` flag to workspace export command
([#794](#794)).
* Ensure profile flag is respected for sync command
([#837](#837)).
* Add hint to delete sync snapshot if parsing fails
([#853](#853)).
* Use profile information when getting a token using the CLI
([#855](#855)).
Bundles:
* Minor template tweaks
([#832](#832)).
* Fixed using repo files as pipeline libraries
([#847](#847)).
* Support .gitignore syntax in sync section and make sure it works
recursively ([#854](#854)).
* Allow target overrides for sync section
([#856](#856)).
Internal:
* Fix import export integration tests on windows
([#842](#842)).
* Fix workspace import test
([#844](#844)).
* Automatically create a release PR in homebrew-tap repo
([#841](#841)).
Dependency updates:
* Bump golang.org/x/term from 0.12.0 to 0.13.0
([#852](#852)).
* Bump golang.org/x/mod from 0.12.0 to 0.13.0
([#851](#851)).
* Bump golang.org/x/sync from 0.3.0 to 0.4.0
([#849](#849)).
* Bump golang.org/x/oauth2 from 0.12.0 to 0.13.0
([#850](#850)).
denik pushed a commit that referenced this pull request May 20, 2026
@shreyas-goenka
Improve workspace import command by allowing references to local fi…
eb72637
…les for content (#793)
## Changes
This PR makes a few really important QOL improvements to the `workspace
import` command.
They are:
1. Adds the `--file` flag, which allows a user to specify a file to read
the content from.
2. Wraps the most common error first time users of this command will run
into with a helpful hint.
3. Minor changes to the command Use string changing `PATH` ->
`TARGET_PATH`
## Tests
Integration tests. The newly added integration tests that check the
--file flag works as expected for both `SOURCE` and `AUTO` format.
Skipped the other formats because the API behaviour for them is
straightforward.
denik pushed a commit that referenced this pull request May 20, 2026
@andrewnester
Release v0.207.1 (#860)
d05fce8
CLI:
* Improve `workspace import` command by allowing references to local
files for content ([#793](#793)).
* Add `--file` flag to workspace export command
([#794](#794)).
* Ensure profile flag is respected for sync command
([#837](#837)).
* Add hint to delete sync snapshot if parsing fails
([#853](#853)).
* Use profile information when getting a token using the CLI
([#855](#855)).
Bundles:
* Minor template tweaks
([#832](#832)).
* Fixed using repo files as pipeline libraries
([#847](#847)).
* Support .gitignore syntax in sync section and make sure it works
recursively ([#854](#854)).
* Allow target overrides for sync section
([#856](#856)).
Internal:
* Fix import export integration tests on windows
([#842](#842)).
* Fix workspace import test
([#844](#844)).
* Automatically create a release PR in homebrew-tap repo
([#841](#841)).
Dependency updates:
* Bump golang.org/x/term from 0.12.0 to 0.13.0
([#852](#852)).
* Bump golang.org/x/mod from 0.12.0 to 0.13.0
([#851](#851)).
* Bump golang.org/x/sync from 0.3.0 to 0.4.0
([#849](#849)).
* Bump golang.org/x/oauth2 from 0.12.0 to 0.13.0
([#850](#850)).
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@pieternpieternAwaiting requested review from pietern
@mgyuchtmgyuchtAwaiting requested review from mgyucht
@andrewnesterandrewnesterAwaiting requested review from andrewnester

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@shreyas-goenka@pietern@andrewnester