Added configuration to temporarily disable the vars plugin (eg in AWX).

changelogs/fragments/114-disable-vars-plugin.yml

@@ -0,0 +1,2 @@
+minor_changes:
+  - "sops vars plugin - added a configuration option to temporarily disable the vars plugin (https://github.com/ansible-collections/community.sops/pull/114)."

plugins/vars/sops.py

@@ -49,6 +49,15 @@
             section: community.sops
         env:
           - name: ANSIBLE_VARS_SOPS_PLUGIN_CACHE
+      _disable_vars_plugin_temporarily:
+        description:
+          - Temporarily disable this plugin.
+          - Useful if ansible-inventory is supposed to be run without decrypting secrets (in AWX for instance).
+        type: bool
+        default: false
+        version_added: 1.3.0
+        env:
+          - name: SOPS_ANSIBLE_AWX_DISABLE_VARS_PLUGIN_TEMPORARILY
     extends_documentation_fragment:
         - ansible.builtin.vars_plugin_staging
         - community.sops.sops
@@ -90,6 +99,9 @@ def get_option_value(argument_name):
         if cache is None:
             cache = self.get_option('cache')
 
+        if self.get_option('_disable_vars_plugin_temporarily'):
+            return {}
+
         data = {}
         for entity in entities:
             if isinstance(entity, Host):

tests/integration/targets/var_sops/test-disable-sops/group_vars

@@ -0,0 +1 @@
+../test-success/group_vars

tests/integration/targets/var_sops/test-disable-sops/hosts

@@ -0,0 +1 @@
+../test-success/hosts

tests/integration/targets/var_sops/test-disable-sops/playbook.yml

@@ -0,0 +1,11 @@
+---
+# Copyright (c) Ansible Project
+# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+- hosts: localhost
+  gather_facts: false
+  tasks:
+    - name: Make sure group_vars/all.sops.yaml was not loaded.
+      debug:
+        msg: '{{ foo }}' # Will throw an undefined error.

tests/integration/targets/var_sops/test-disable-sops/run.sh

@@ -0,0 +1,8 @@
+#!/bin/sh
+# Copyright (c) Ansible Project
+# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+set -e
+SOPS_ANSIBLE_AWX_DISABLE_VARS_PLUGIN_TEMPORARILY=true \
+ansible-playbook playbook.yml -i hosts -v "$@"

tests/integration/targets/var_sops/test-disable-sops/validate.sh

@@ -0,0 +1,12 @@
+#!/bin/sh
+# Copyright (c) Ansible Project
+# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+set -eux
+
+if [ "$1" != 2 ]; then
+    exit 1
+fi
+
+grep -F "The error was: 'foo' is undefined" "$2"