Use updates_url for plugin version if it exists

Author: YoussefKhalidAli

plugins/modules/jenkins_plugin.py

@@ -93,6 +93,13 @@
       - A list of URL segment(s) to retrieve the update center JSON file from.
     default: ['update-center.json', 'updates/update-center.json']
     version_added: 3.3.0
+  plugin_versions_url_segment:
+    type: list
+    elements: str
+    description:
+      - A list of URL segment(s) to retrieve the plugin versions JSON file from.
+    default: ['plugin-versions.json', 'current/plugin-versions.json']
+    version_added: 11.1.0
   latest_plugins_url_segments:
     type: list
     elements: str
@@ -688,6 +695,10 @@ def _get_latest_compatible_plugin_version(self, plugin_name=None):
             self.jenkins_version = self.parse_version(raw_version)
         name = plugin_name or self.params['name']
         cache_path = "{}/ansible_jenkins_plugin_cache.json".format(self.params['jenkins_home'])
+        plugin_version_urls = []
+        for base_url in self.params['updates_url']:
+            for update_json in self.params['plugin_versions_url_segment']:
+                plugin_version_urls.append("{}/{}".format(base_url, update_json))
 
         try:  # Check if file is saved localy
             if os.path.exists(cache_path):
@@ -697,10 +708,19 @@ def _get_latest_compatible_plugin_version(self, plugin_name=None):
 
             now = time.time()
             if now - file_mtime >= 86400:
-                response, info = fetch_url(self.module, "https://updates.jenkins.io/current/plugin-versions.json")
-                if info['status'] != 200:
-                    self.module.fail_json(msg="Failed to fetch plugin-versions.json", details=info)
-                plugin_data = json.loads(to_native(response.read()), object_pairs_hook=OrderedDict)
+                try:
+                    response = self._get_urls_data(plugin_version_urls, what="plugin-versions.json")
+                    plugin_data = json.loads(to_native(response.read()), object_pairs_hook=OrderedDict)
+                    if "plugins" not in plugin_data:
+                        raise ValueError("Missing 'plugins' key")
+                except Exception as e:
+                    self.module.warn(
+                        "Could not fetch plugin-versions.json from custom updates_url(s). Falling back to updates.jenkins.io. Details: {}".format(to_native(e))
+                    )
+                    response, info = fetch_url(self.module, "https://updates.jenkins.io/current/plugin-versions.json")
+                    if info['status'] != 200:
+                        self.module.fail_json(msg="Failed to fetch fallback plugin-versions.json", details=info)
+                    plugin_data = json.loads(to_native(response.read()), object_pairs_hook=OrderedDict)
 
                 # Save it to file for next time
                 with open(cache_path, "w") as f:
@@ -710,6 +730,8 @@ def _get_latest_compatible_plugin_version(self, plugin_name=None):
                 plugin_data = json.load(f)
 
         except Exception as e:
+            if os.path.exists(cache_path):
+                os.remove(cache_path)
             self.module.fail_json(msg="Failed to parse plugin-versions.json", details=to_native(e))
 
         plugin_versions = plugin_data.get("plugins", {}).get(name)
@@ -939,6 +961,8 @@ def main():
         updates_url_password=dict(type="str", no_log=True),
         update_json_url_segment=dict(type="list", elements="str", default=['update-center.json',
                                                                            'updates/update-center.json']),
+        plugin_versions_url_segment=dict(type="list", elements="str", default=['plugin-versions.json',
+                                                                               'current/plugin-versions.json']),
         latest_plugins_url_segments=dict(type="list", elements="str", default=['latest']),
         versioned_plugins_url_segments=dict(type="list", elements="str", default=['download/plugins', 'plugins']),
         url=dict(default='http://localhost:8080'),
@@ -968,7 +992,7 @@ def main():
         module.params['state'] = 'present'
         module.params['version'] = jp._get_latest_compatible_plugin_version()
 
-    # Ser version to latest compatible version if version is latest
+    # Set version to latest compatible version if version is latest
     if module.params['version'] == 'latest':
         module.params['version'] = jp._get_latest_compatible_plugin_version()
 

tests/unit/plugins/modules/test_jenkins_plugin.py

@@ -209,6 +209,7 @@ def test__get_latest_compatible_plugin_version(fetch_mock, mocker):
         "name": "git",
         "version": "latest",
         "updates_url": ["https://some.base.url"],
+        "plugin_versions_url_segment": ["plugin-versions.json"],
         "latest_plugins_url_segments": ["test_latest"],
         "jenkins_home": "/var/lib/jenkins",
     }