Release v0.5.0 (#87)

* Added `make_run_as` fixture
([#82](#82)). A new
pytest fixture, `make_run_as`, has been added to create an account
service principal via the `acc` fixture and assign it to a workspace
with default permissions, which is removed after the test is complete.
The fixture creates a service principal with a random display name and
assigns it to the workspace. Users can optionally assign the service
principal to account groups for specific actions using the
`account_groups` argument. The returned object contains properties for
the workspace client, SQL backend, and SQL execution functions, as well
as the display name and application ID of the ephemeral service
principal. If desired, the `ws` fixture can be overridden to make all
workspace fixtures provided by the plugin run as the ephemeral service
principal, allowing for testing with lower privilege ephemeral service
principals and improving security and isolation. This feature is not
currently supported with Databricks Metadata Service authentication on
Azure Databricks.
* Bump codecov/codecov-action from 4 to 5
([#85](#85)). In this
release, the Codecov GitHub Action has been updated from version 4 to 5,
introducing several new features and changes. The new version uses the
Codecov Wrapper to encapsulate the CLI, allowing for quicker updates to
the Action. Additionally, version 5 includes an opt-out feature for
tokens in public repositories, enabling contributors and other members
to upload coverage reports without requiring access to the Codecov
token. This can be accomplished by setting the ability for Codecov to
receive a coverage report from any source in the Global Upload Token
section of the settings page on codecov.io. Furthermore, the updated
version introduces several new arguments, including `binary`,
`gcov_args`, `gcov_executable`, `gcov_ignore`, `gcov_include`,
`report_type`, and `skip_validation`, and changes the `file` and
`plugin` arguments to `files` and `plugins`, respectively.
* Bump databrickslabs/sandbox from acceptance/v0.3.1 to 0.4.2
([#80](#80)). In this
release, the `databrickslabs/sandbox` dependency has been updated from
version `acceptance/v0.3.1` to `0.4.2`. This update includes the
addition of install instructions, more go-git libraries, and
modifications to the README to explain how to use the library with the
`databricks labs sandbox` command. Dependency updates include
golang.org/x/crypto from version 0.16.0 to 0.17.0. The `Run nightly
tests` job in the workflow has also been updated to use the new version
of the `databrickslabs/sandbox/acceptance` image. The commit history for
this release shows several commits, including the creation of "[TODO]
XXX" issues and a full diff comparison. The pull request includes
instructions for triggering Dependabot actions through comments.
Reviewers are encouraged to thoroughly examine the changelog and commit
history for more detailed information on the changes in this release.
* Force keyword argument in `make_query` fixture
([#81](#81)). In the
latest update, the `make_query` fixture in the `redash.py` file has
undergone changes to enhance code readability and maintainability. The
`sql_query` parameter is now required to be passed as a keyword
argument, preventing the possibility of it being mistakenly passed as a
positional argument. Furthermore, the `create` function's signature has
been revised to include an explicit \* before the `sql_query` parameter.
It is important to note that these changes have not affected the
functionality of the method, but have instead altered the parameter
passing style for improved clarity. This minor update is intended to
elevate the overall quality of the codebase and promote best practices.
* Renamed internal `notebooks` module to `workspace`
([#86](#86)). In this
release, the internal `notebooks` module has been renamed to `workspace`
to better reflect its current functionality of managing and interacting
with notebooks and other resources in a Databricks workspace. This
renaming applies to the import statements in `plugin.py` and
`test_notebooks.py`, which has been renamed to `test_workspace.py`.
Additionally, import statements for making cluster policy and instance
pool permissions have been added. The functionality of the imported
functions, such as `make_directory`, `make_workspace_file`,
`make_notebook`, and `make_repo`, remains unchanged. This change is part
of the fix for issue
[#59](#59) and aims to
improve the clarity and consistency of the codebase. Software engineers
adopting this project should update any imports or references to the
`notebooks` module to use the new `workspace` module instead.

Dependency updates:

* Bump databrickslabs/sandbox from acceptance/v0.3.1 to 0.4.2
([#80](#80)).
* Bump codecov/codecov-action from 4 to 5
([#85](#85)).

Author: nfx

CHANGELOG.md

@@ -1,5 +1,18 @@
 # Version changelog
 
+## 0.5.0
+
+* Added `make_run_as` fixture ([#82](https://github.com/databrickslabs/pytester/issues/82)). A new pytest fixture, `make_run_as`, has been added to create an account service principal via the `acc` fixture and assign it to a workspace with default permissions, which is removed after the test is complete. The fixture creates a service principal with a random display name and assigns it to the workspace. Users can optionally assign the service principal to account groups for specific actions using the `account_groups` argument. The returned object contains properties for the workspace client, SQL backend, and SQL execution functions, as well as the display name and application ID of the ephemeral service principal. If desired, the `ws` fixture can be overridden to make all workspace fixtures provided by the plugin run as the ephemeral service principal, allowing for testing with lower privilege ephemeral service principals and improving security and isolation. This feature is not currently supported with Databricks Metadata Service authentication on Azure Databricks.
+* Bump codecov/codecov-action from 4 to 5 ([#85](https://github.com/databrickslabs/pytester/issues/85)). In this release, the Codecov GitHub Action has been updated from version 4 to 5, introducing several new features and changes. The new version uses the Codecov Wrapper to encapsulate the CLI, allowing for quicker updates to the Action. Additionally, version 5 includes an opt-out feature for tokens in public repositories, enabling contributors and other members to upload coverage reports without requiring access to the Codecov token. This can be accomplished by setting the ability for Codecov to receive a coverage report from any source in the Global Upload Token section of the settings page on codecov.io. Furthermore, the updated version introduces several new arguments, including `binary`, `gcov_args`, `gcov_executable`, `gcov_ignore`, `gcov_include`, `report_type`, and `skip_validation`, and changes the `file` and `plugin` arguments to `files` and `plugins`, respectively.
+* Bump databrickslabs/sandbox from acceptance/v0.3.1 to 0.4.2 ([#80](https://github.com/databrickslabs/pytester/issues/80)). In this release, the `databrickslabs/sandbox` dependency has been updated from version `acceptance/v0.3.1` to `0.4.2`. This update includes the addition of install instructions, more go-git libraries, and modifications to the README to explain how to use the library with the `databricks labs sandbox` command. Dependency updates include golang.org/x/crypto from version 0.16.0 to 0.17.0. The `Run nightly tests` job in the workflow has also been updated to use the new version of the `databrickslabs/sandbox/acceptance` image. The commit history for this release shows several commits, including the creation of "[TODO] XXX" issues and a full diff comparison. The pull request includes instructions for triggering Dependabot actions through comments. Reviewers are encouraged to thoroughly examine the changelog and commit history for more detailed information on the changes in this release.
+* Force keyword argument in `make_query` fixture ([#81](https://github.com/databrickslabs/pytester/issues/81)). In the latest update, the `make_query` fixture in the `redash.py` file has undergone changes to enhance code readability and maintainability. The `sql_query` parameter is now required to be passed as a keyword argument, preventing the possibility of it being mistakenly passed as a positional argument. Furthermore, the `create` function's signature has been revised to include an explicit \* before the `sql_query` parameter. It is important to note that these changes have not affected the functionality of the method, but have instead altered the parameter passing style for improved clarity. This minor update is intended to elevate the overall quality of the codebase and promote best practices.
+* Renamed internal `notebooks` module to `workspace` ([#86](https://github.com/databrickslabs/pytester/issues/86)). In this release, the internal `notebooks` module has been renamed to `workspace` to better reflect its current functionality of managing and interacting with notebooks and other resources in a Databricks workspace. This renaming applies to the import statements in `plugin.py` and `test_notebooks.py`, which has been renamed to `test_workspace.py`. Additionally, import statements for making cluster policy and instance pool permissions have been added. The functionality of the imported functions, such as `make_directory`, `make_workspace_file`, `make_notebook`, and `make_repo`, remains unchanged. This change is part of the fix for issue [#59](https://github.com/databrickslabs/pytester/issues/59) and aims to improve the clarity and consistency of the codebase. Software engineers adopting this project should update any imports or references to the `notebooks` module to use the new `workspace` module instead.
+
+Dependency updates:
+
+ * Bump databrickslabs/sandbox from acceptance/v0.3.1 to 0.4.2 ([#80](https://github.com/databrickslabs/pytester/pull/80)).
+ * Bump codecov/codecov-action from 4 to 5 ([#85](https://github.com/databrickslabs/pytester/pull/85)).
+
 ## 0.4.0
 
 * Added Volume Fixture ([#72](https://github.com/databrickslabs/pytester/issues/72)). This commit introduces a Managed Volume fixture, `make_volume`, to the Unity Catalog in the test suite, facilitating the creation and use of a random volume for testing purposes. The fixture, when called without arguments, generates a volume with a random name. Alternatively, specifying the `name` argument creates a volume with the given name, using the `MANAGED` volume type, and associating it with a randomly generated catalog and schema. This promotes test isolation and prevents unintended interference. Additionally, this PR resolves issue [#70](https://github.com/databrickslabs/pytester/issues/70) and includes unit and integration tests that have been manually verified to ensure the fixture's proper functioning. The commit also demonstrates a bug fix related to table retrieval in the `test_remove_after_property_table` test case.

src/databricks/labs/pytester/__about__.py

@@ -1 +1 @@
-__version__ = "0.4.0"
+__version__ = "0.5.0"