From d0c82aec86f844ccb1dcc07ec4acf9eedc87730d Mon Sep 17 00:00:00 2001
From: Jonas L <jooola@users.noreply.github.com>
Date: Mon, 5 Feb 2024 12:18:39 +0100
Subject: [PATCH] feat!: remove inventory `api_token_env` option (#454)

##### SUMMARY

Remove the previously deprecated `api_token_env` to fully leverage the
ansible inventory options loader.

##### ISSUE TYPE

- Feature Pull Request


##### COMPONENT NAME

inventory
---
 .../remove-inventory-api_token_env-option.yml |  2 ++
 plugins/inventory/hcloud.py                   | 35 +------------------
 2 files changed, 3 insertions(+), 34 deletions(-)
 create mode 100644 changelogs/fragments/remove-inventory-api_token_env-option.yml

diff --git a/changelogs/fragments/remove-inventory-api_token_env-option.yml b/changelogs/fragments/remove-inventory-api_token_env-option.yml
new file mode 100644
index 0000000..9604627
--- /dev/null
+++ b/changelogs/fragments/remove-inventory-api_token_env-option.yml
@@ -0,0 +1,2 @@
+breaking_changes:
+  - inventory - Remove the deprecated `api_token_env` option, you may use the `ansible.builtin.env` lookup as alternative.
diff --git a/plugins/inventory/hcloud.py b/plugins/inventory/hcloud.py
index 4493422..99eaec0 100644
--- a/plugins/inventory/hcloud.py
+++ b/plugins/inventory/hcloud.py
@@ -32,21 +32,10 @@ options:
     description:
       - The API Token for the Hetzner Cloud.
     type: str
-    required: false # TODO: Mark as required once 'api_token_env' is removed.
+    required: true
     aliases: [token]
     env:
       - name: HCLOUD_TOKEN
-  api_token_env:
-    description:
-      - Environment variable name to load the Hetzner Cloud API Token from.
-    type: str
-    default: HCLOUD_TOKEN
-    aliases: [token_env]
-    deprecated:
-      why: The option is adding too much complexity, while the alternatives are preferred.
-      collection_name: hetzner.hcloud
-      version: 3.0.0
-      alternatives: Use the P(ansible.builtin.env#lookup) lookup plugin instead.
   api_endpoint:
     description:
       - The API Endpoint for the Hetzner Cloud.
@@ -155,7 +144,6 @@ keyed_groups:
     prefix: server_status
 """
 
-import os
 import sys
 from ipaddress import IPv6Network
 
@@ -243,30 +231,9 @@ class InventoryModule(BaseInventoryPlugin, Constructable, Cacheable):
     network: Network | None
 
     def _configure_hcloud_client(self):
-        # If api_token_env is not the default, print a deprecation warning and load the
-        # environment variable.
-        api_token_env = self.get_option("api_token_env")
-        if api_token_env != "HCLOUD_TOKEN":
-            self.display.deprecated(
-                "The 'api_token_env' option is deprecated, please use the 'HCLOUD_TOKEN' "
-                "environment variable or use the 'ansible.builtin.env' lookup instead.",
-                version="3.0.0",
-                collection_name="hetzner.hcloud",
-            )
-            if api_token_env in os.environ:
-                self.set_option("api_token", os.environ.get(api_token_env))
-
         api_token = self.get_option("api_token")
         api_endpoint = self.get_option("api_endpoint")
 
-        if api_token is None:  # TODO: Remove once I(api_token_env) is removed.
-            raise AnsibleError(
-                "No setting was provided for required configuration setting: "
-                "plugin_type: inventory "
-                "plugin: hetzner.hcloud.hcloud "
-                "setting: api_token"
-            )
-
         # Resolve template string
         api_token = self.templar.template(api_token)