Skip to content

Add workspace import-dir command#456

Merged
shreyas-goenka merged 25 commits intomainfrom
import-dir-1
Jun 12, 2023
Merged

Add workspace import-dir command#456
shreyas-goenka merged 25 commits intomainfrom
import-dir-1

Conversation

@shreyas-goenka
Copy link
Copy Markdown
Contributor

@shreyas-goenka shreyas-goenka commented Jun 9, 2023

Tests

Testing using integration tests and manually

@shreyas-goenka
Copy link
Copy Markdown
Contributor Author

shreyas-goenka commented Jun 9, 2023

case 1: target directory does not exist

shreyas.goenka@THW32HFW6T vandaley-industries % cli workspace import-dir foo /Users/[email protected]/remote-dir
.gitignore -> /Users/[email protected]/remote-dir/.gitignore
apple -> /Users/[email protected]/remote-dir/apple
hello_world.py -> /Users/[email protected]/remote-dir/hello_world
mango -> /Users/[email protected]/remote-dir/mango
veggies/tomatoes -> /Users/[email protected]/remote-dir/veggies/tomatoes

case 2: A few preexisting files at target dir

shreyas.goenka@THW32HFW6T vandaley-industries % cli workspace import-dir foo /Users/[email protected]/remote-dir
.gitignore -> /Users/[email protected]/remote-dir/.gitignore (skipped; already exists)
apple -> /Users/[email protected]/remote-dir/apple
hello_world.py -> /Users/[email protected]/remote-dir/hello_world (skipped; already exists)
mango -> /Users/[email protected]/remote-dir/mango
veggies/tomatoes -> /Users/[email protected]/remote-dir/veggies/tomatoes

case 3: preexisting files, but overwrite flag is set

shreyas.goenka@THW32HFW6T vandaley-industries % cli workspace import-dir foo /Users/[email protected]/remote-dir --overwrite
.gitignore -> /Users/[email protected]/remote-dir/.gitignore
apple -> /Users/[email protected]/remote-dir/apple
hello_world.py -> /Users/[email protected]/remote-dir/hello_world
mango -> /Users/[email protected]/remote-dir/mango
veggies/tomatoes -> /Users/[email protected]/remote-dir/veggies/tomatoes

case 4: json output mode

shreyas.goenka@THW32HFW6T vandaley-industries % cli workspace import-dir foo /Users/[email protected]/remote-dir --overwrite --output=json
{
  "source_path":"/Users/shreyas.goenka/projects/vandaley-industries/foo",
  "type":"IMPORT_STARTED"
}
{
  "source_path":".gitignore",
  "target_path":"/Users/[email protected]/remote-dir/.gitignore",
  "type":"FILE_IMPORTED"
}
{
  "source_path":"apple",
  "target_path":"/Users/[email protected]/remote-dir/apple",
  "type":"FILE_IMPORTED"
}
{
  "source_path":"hello_world.py",
  "target_path":"/Users/[email protected]/remote-dir/hello_world",
  "type":"FILE_IMPORTED"
}
{
  "source_path":"mango",
  "target_path":"/Users/[email protected]/remote-dir/mango",
  "type":"FILE_IMPORTED"
}
{
  "source_path":"veggies/tomatoes",
  "target_path":"/Users/[email protected]/remote-dir/veggies/tomatoes",
  "type":"FILE_IMPORTED"
}
{
  "target_path":"/Users/[email protected]/remote-dir",
  "type":"IMPORT_COMPLETED"
}
shreyas.goenka@THW32HFW6T vandaley-industries %

@shreyas-goenka shreyas-goenka requested review from nfx and pietern June 9, 2023 00:44
pietern
pietern reviewed Jun 9, 2023
View reviewed changes
shreyas-goenka
shreyas-goenka commented Jun 9, 2023
View reviewed changes
@shreyas-goenka shreyas-goenka requested a review from pietern June 9, 2023 18:51
pietern
pietern reviewed Jun 12, 2023
View reviewed changes
@pietern pietern mentioned this pull request Jun 12, 2023
Closed
@shreyas-goenka shreyas-goenka requested a review from pietern June 12, 2023 13:25
pietern
pietern approved these changes Jun 12, 2023
View reviewed changes
Copy link
Copy Markdown
Contributor

@pietern pietern left a comment

Choose a reason for hiding this comment

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

Final minor issues. Everything else LGTM.

@shreyas-goenka shreyas-goenka requested a review from pietern June 12, 2023 15:54
@shreyas-goenka shreyas-goenka merged commit d386490 into main Jun 12, 2023
@shreyas-goenka shreyas-goenka deleted the import-dir-1 branch June 12, 2023 19:03
@pietern pietern mentioned this pull request Jun 15, 2023
Merged
pietern added a commit that referenced this pull request Jun 15, 2023
@pietern
Release v0.100.4 (#486)
18e1d93 
## Changes

CLI:
* Add workspace import-dir command
([#456](#456)).
* Annotate generated commands with OpenAPI package name
([#466](#466)).
* Associate generated commands with command groups
([#475](#475)).
* Disable shell completions for generated commands
([#483](#483)).
* Include [DEFAULT] section header when writing ~/.databrickscfg
([#464](#464)).
* Pass through proxy related environment variables
([#465](#465)).
* Restore flags to original values on test completion
([#470](#470)).
* Update configure command
([#482](#482)).

Dependencies:
* Bump SDK to latest
([#473](#473)).
@s4m0r4m4
Copy link
Copy Markdown

s4m0r4m4 commented Sep 28, 2023

@shreyas-goenka It looks like this did not make it into the docs, should I spin up a new ticket for that?

https://github.com/databricks/cli/blob/main/docs/commands.md#databricks-workspace---the-workspace-api-allows-you-to-list-import-export-and-delete-notebooks-and-folders

@pietern
Copy link
Copy Markdown
Contributor

pietern commented Oct 2, 2023

@s4m0r4m4 Thanks for noticing. That doc hasn't been updated after it was first added (we don't have automation for it). Out of curiosity -- are you actively using that as a reference?

@s4m0r4m4
Copy link
Copy Markdown

s4m0r4m4 commented Oct 2, 2023

I am! I used to use the legacy documentation and was trying to upgrade and use the newer documentation but it doesn't seem to be quite as fleshed out as the older stuff

@pietern
Copy link
Copy Markdown
Contributor

pietern commented Oct 3, 2023

Understood -- yeah, the docs were autogenerated from our API explorer, so the manually curated commands didn't show up there. I filed issue #829 to track this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@pietern pietern pietern approved these changes

@nfx nfx Awaiting requested review from nfx

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 @s4m0r4m4 @pietern