From 53f990803682b6bda5829e344cecacb1c7507d22 Mon Sep 17 00:00:00 2001 From: Serge Smertin <serge.smertin@databricks.com> Date: Tue, 16 Apr 2024 20:01:58 +0200 Subject: [PATCH] Release v0.1.0 * Added checks for mocking best practices ([#27](https://github.com/databrickslabs/pylint-plugin/issues/27)). A new `mocking` checker has been added to the pylint plugin for Databricks to improve the quality of unit tests by enforcing best practices in mocking. This checker introduces two rules: `explicit-dependency-required` and `obscure-mock`. The `explicit-dependency-required` rule encourages injecting dependencies through constructors instead of using `mock.patch`, promoting code readability, maintainability, and dependency inversion for unit testing. The `obscure-mock` rule recommends using `create_autospec(ConcreteType)` over `MagicMock` to create mock objects that behave like concrete classes, resulting in more robust and maintainable unit tests. These rules can be configured to specify package names containing project code. This addition helps developers create reliable, maintainable, and testable code by adhering to recommended mocking practices. --- CHANGELOG.md | 5 +++++ src/databricks/labs/pylint/__about__.py | 2 +- 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 8ed4789..8d01e20 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,10 @@ # Version changelog +## 0.1.0 + +* Added checks for mocking best practices ([#27](https://github.com/databrickslabs/pylint-plugin/issues/27)). A new `mocking` checker has been added to the pylint plugin for Databricks to improve the quality of unit tests by enforcing best practices in mocking. This checker introduces two rules: `explicit-dependency-required` and `obscure-mock`. The `explicit-dependency-required` rule encourages injecting dependencies through constructors instead of using `mock.patch`, promoting code readability, maintainability, and dependency inversion for unit testing. The `obscure-mock` rule recommends using `create_autospec(ConcreteType)` over `MagicMock` to create mock objects that behave like concrete classes, resulting in more robust and maintainable unit tests. These rules can be configured to specify package names containing project code. This addition helps developers create reliable, maintainable, and testable code by adhering to recommended mocking practices. + + ## 0.0.1 Initial public release diff --git a/src/databricks/labs/pylint/__about__.py b/src/databricks/labs/pylint/__about__.py index f102a9c..3dc1f76 100644 --- a/src/databricks/labs/pylint/__about__.py +++ b/src/databricks/labs/pylint/__about__.py @@ -1 +1 @@ -__version__ = "0.0.1" +__version__ = "0.1.0"