Bug fix: Warns user if incorrect SDK version is installed (#4422)

* Add error handling to check correct SDK version installed * Fix CI errors * Added changelog fragment * Changed exeption type * Update changelogs fragment Co-authored-by: Felix Fontein <felix@fontein.de> Co-authored-by: Felix Fontein <felix@fontein.de>
ansible-collections · Apr 5, 2022 · e7ffa76 · e7ffa76
1 parent 79256b2
commit e7ffa76
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 2 deletions.
diff --git a/changelogs/fragments/4422-warn-user-if-incorrect-SDK-version-is-installed.yaml b/changelogs/fragments/4422-warn-user-if-incorrect-SDK-version-is-installed.yaml
@@ -0,0 +1,3 @@
+---
+bugfixes:
+  - dsv lookup plugin - raise an Ansible error if the wrong ``python-dsv-sdk`` version is installed (https://github.com/ansible-collections/community.general/pull/4422).
diff --git a/plugins/lookup/dsv.py b/plugins/lookup/dsv.py
@@ -105,11 +105,15 @@
 class LookupModule(LookupBase):
     @staticmethod
     def Client(vault_parameters):
-        return SecretsVault(**vault_parameters)
+        try:
+            vault = SecretsVault(**vault_parameters)
+            return vault
+        except TypeError:
+            raise AnsibleError("python-dsv-sdk==0.0.1 must be installed to use this plugin")
 
     def run(self, terms, variables, **kwargs):
         if sdk_is_missing:
-            raise AnsibleError("python-dsv-sdk must be installed to use this plugin")
+            raise AnsibleError("python-dsv-sdk==0.0.1 must be installed to use this plugin")
 
         self.set_options(var_options=variables, direct=kwargs)