Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Only treat files with .tmpl extension as templates #594

Merged
merged 15 commits into from
Aug 1, 2023
Merged

Only treat files with .tmpl extension as templates #594

merged 15 commits into from
Aug 1, 2023

Conversation

shreyas-goenka
Copy link
Contributor

@shreyas-goenka shreyas-goenka commented Jul 21, 2023 •
edited
Loading

Changes

In a world before this PR, all files would be treated as go text templates, making the content in these files quake in fear since they would be executed (as a template).

This PR makes it so that only files with the .tmpl extension are understood to be templates. This is useful for avoiding ambiguity in cases like where a binary file could be interpreted as a go text template otherwise.

In order to do so, we introduce the copyFile struct which does a copy of the source file from the template without loading it into memory.

Tests

Unit tests

pietern
pietern reviewed Jul 27, 2023
View reviewed changes
libs/template/renderer.go Outdated Show resolved Hide resolved
libs/template/file.go Outdated Show resolved Hide resolved
libs/template/file.go Outdated Show resolved Hide resolved
libs/template/file.go Outdated Show resolved Hide resolved
libs/template/file_test.go Outdated Show resolved Hide resolved
libs/template/file_test.go Show resolved Hide resolved
libs/template/renderer.go Show resolved Hide resolved
libs/template/renderer.go Outdated Show resolved Hide resolved
@shreyas-goenka
Copy link
Contributor Author

Refactored the code to have a destinationPath struct which makes the interfaces cleaner and easier to understand

@shreyas-goenka shreyas-goenka added this pull request to the merge queue Aug 1, 2023
Merged via the queue into main with commit fc8729d Aug 1, 2023
4 checks passed
@shreyas-goenka shreyas-goenka deleted the add-tmpl-extension-requirement branch August 1, 2023 13:52
pietern added a commit that referenced this pull request Aug 10, 2023
@pietern
Release v0.203.0
1c00d4f 
CLI:
 * Infer host from profile during `auth login` ([#629](#629)).

Bundles:
 * Extend deployment mode support ([#577](#577)).
 * Add validation for Git settings in bundles ([#578](#578)).
 * Only treat files with .tmpl extension as templates ([#594](#594)).
 * Add JSON schema validation for input template parameters ([#598](#598)).
 * Add DATABRICKS_BUNDLE_INCLUDE_PATHS to specify include paths through env vars ([#591](#591)).
 * Initialise a empty default bundle if BUNDLE_ROOT and DATABRICKS_BUNDLE_INCLUDES env vars are present ([#604](#604)).
 * Regenerate bundle resource structs from latest Terraform provider ([#633](#633)).
 * Fixed processing jobs libraries with remote path ([#638](#638)).
 * Add unit test for file name execution during rendering ([#640](#640)).
 * Add bundle init command and support for prompting user for input values ([#631](#631)).
 * Fix bundle git branch validation ([#645](#645)).

Internal:
 * Fix mkdir integration test on GCP ([#620](#620)).
 * Fix git clone integration test for non-existing repo ([#610](#610)).
 * Remove push to main trigger for build workflow ([#621](#621)).
 * Remove workflow to publish binaries to S3 ([#622](#622)).
 * Fix failing fs mkdir test on azure ([#627](#627)).
 * Print y/n options when displaying prompts using cmdio.Ask ([#650](#650)).

API Changes:
 * Changed `databricks account metastore-assignments create` command to not return anything.
 * Added `databricks account network-policy` command group.

OpenAPI commit 7b57ba3a53f4de3d049b6a24391fe5474212daf8 (2023-07-28)

Dependency updates:
 * Bump OpenAPI specification & Go SDK Version ([#624](#624)).
 * Bump golang.org/x/term from 0.10.0 to 0.11.0 ([#643](#643)).
 * Bump golang.org/x/text from 0.11.0 to 0.12.0 ([#642](#642)).
 * Bump golang.org/x/oauth2 from 0.10.0 to 0.11.0 ([#641](#641)).
@pietern pietern mentioned this pull request Aug 10, 2023
Merged
github-merge-queue bot pushed a commit that referenced this pull request Aug 10, 2023
@pietern
Release v0.203.0 (#653)
979b680 
CLI:
* Infer host from profile during `auth login`
([#629](#629)).

Bundles:
* Extend deployment mode support
([#577](#577)).
* Add validation for Git settings in bundles
([#578](#578)).
* Only treat files with .tmpl extension as templates
([#594](#594)).
* Add JSON schema validation for input template parameters
([#598](#598)).
* Add DATABRICKS_BUNDLE_INCLUDE_PATHS to specify include paths through
env vars ([#591](#591)).
* Initialise a empty default bundle if BUNDLE_ROOT and
DATABRICKS_BUNDLE_INCLUDES env vars are present
([#604](#604)).
* Regenerate bundle resource structs from latest Terraform provider
([#633](#633)).
* Fixed processing jobs libraries with remote path
([#638](#638)).
* Add unit test for file name execution during rendering
([#640](#640)).
* Add bundle init command and support for prompting user for input
values ([#631](#631)).
* Fix bundle git branch validation
([#645](#645)).

Internal:
* Fix mkdir integration test on GCP
([#620](#620)).
* Fix git clone integration test for non-existing repo
([#610](#610)).
* Remove push to main trigger for build workflow
([#621](#621)).
* Remove workflow to publish binaries to S3
([#622](#622)).
* Fix failing fs mkdir test on azure
([#627](#627)).
* Print y/n options when displaying prompts using cmdio.Ask
([#650](#650)).

API Changes:
* Changed `databricks account metastore-assignments create` command to
not return anything.
 * Added `databricks account network-policy` command group.

OpenAPI commit 7b57ba3a53f4de3d049b6a24391fe5474212daf8 (2023-07-28)

Dependency updates:
* Bump OpenAPI specification & Go SDK Version
([#624](#624)).
* Bump golang.org/x/term from 0.10.0 to 0.11.0
([#643](#643)).
* Bump golang.org/x/text from 0.11.0 to 0.12.0
([#642](#642)).
* Bump golang.org/x/oauth2 from 0.10.0 to 0.11.0
([#641](#641)).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@pietern pietern pietern left review comments

@andrewnester andrewnester andrewnester approved these changes

@mgyucht mgyucht Awaiting requested review from mgyucht

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@shreyas-goenka @pietern @andrewnester