netbox-atlassian 0.2.2__tar.gz → 0.2.4__tar.gz

{netbox_atlassian-0.2.2 → netbox_atlassian-0.2.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: netbox-atlassian
-Version: 0.2.2
+Version: 0.2.4
 Summary: NetBox plugin to display Jira issues and Confluence pages related to devices
 Author-email: sieteunoseis <jeremy.worden@gmail.com>
 License: Apache-2.0

netbox_atlassian-0.2.4/netbox_atlassian/__init__.py

@@ -0,0 +1,148 @@
+"""
+NetBox Atlassian Plugin
+
+Display Jira issues and Confluence pages related to devices in NetBox.
+Searches by configurable fields (hostname, serial, role, etc.) with OR logic.
+"""
+
+import logging
+
+from netbox.plugins import PluginConfig
+
+__version__ = "0.2.4"
+
+logger = logging.getLogger(__name__)
+
+
+class AtlassianConfig(PluginConfig):
+    """Plugin configuration for NetBox Atlassian integration."""
+
+    name = "netbox_atlassian"
+    verbose_name = "Atlassian"
+    description = "Display Jira issues and Confluence pages related to devices"
+    version = __version__
+    author = "sieteunoseis"
+    author_email = "sieteunoseis@github.com"
+    base_url = "atlassian"
+    min_version = "4.0.0"
+
+    # Required settings - plugin won't load without these
+    required_settings = []
+
+    # Default configuration values
+    default_settings = {
+        # Jira settings (on-prem)
+        "jira_url": "",  # e.g., "https://jira.example.com"
+        "jira_username": "",
+        "jira_password": "",  # or API token
+        "jira_token": "",  # Personal Access Token (PAT) - preferred for on-prem
+        "jira_verify_ssl": True,
+        # Confluence settings (on-prem)
+        "confluence_url": "",  # e.g., "https://confluence.example.com"
+        "confluence_username": "",
+        "confluence_password": "",  # or API token
+        "confluence_token": "",  # Personal Access Token (PAT) - preferred for on-prem
+        "confluence_verify_ssl": True,
+        # Cloud settings (for future use)
+        "use_cloud": False,
+        "cloud_api_token": "",
+        "cloud_email": "",
+        # Search configuration
+        # Fields to search - values are device attribute paths
+        # Searches use OR logic - matches any field
+        "search_fields": [
+            {"name": "Hostname", "attribute": "name", "enabled": True},
+            {"name": "Serial", "attribute": "serial", "enabled": True},
+            {"name": "Asset Tag", "attribute": "asset_tag", "enabled": False},
+            {"name": "Role", "attribute": "role.name", "enabled": False},
+            {"name": "Primary IP", "attribute": "primary_ip4.address", "enabled": False},
+        ],
+        # Endpoint search fields (for netbox-endpoints plugin)
+        # Searches use OR logic - matches any field
+        "endpoint_search_fields": [
+            {"name": "Name", "attribute": "name", "enabled": True},
+            {"name": "MAC Address", "attribute": "mac_address", "enabled": True},
+            {"name": "Serial", "attribute": "serial", "enabled": True},
+            {"name": "Asset Tag", "attribute": "asset_tag", "enabled": False},
+        ],
+        # Jira search settings
+        "jira_max_results": 10,
+        "jira_projects": [],  # Empty = search all projects
+        "jira_issue_types": [],  # Empty = all types
+        # Confluence search settings
+        "confluence_max_results": 10,
+        "confluence_spaces": [],  # Empty = search all spaces
+        # General settings
+        "timeout": 30,
+        "cache_timeout": 300,  # Cache results for 5 minutes
+        # Enable legacy SSL renegotiation for older servers (required for OHSU wiki)
+        "enable_legacy_ssl": False,
+        # Device type filtering (like catalyst-center)
+        # Empty list = show tab for all devices
+        "device_types": [],  # e.g., ["cisco", "juniper"]
+    }
+
+    def ready(self):
+        """Register endpoint view if netbox_endpoints is available."""
+        super().ready()
+        self._register_endpoint_views()
+
+    def _register_endpoint_views(self):
+        """Register Atlassian tab for Endpoints if plugin is installed."""
+        import sys
+
+        # Quick check if netbox_endpoints is available
+        if "netbox_endpoints" not in sys.modules:
+            try:
+                import importlib.util
+
+                if importlib.util.find_spec("netbox_endpoints") is None:
+                    logger.debug("netbox_endpoints not installed, skipping endpoint view registration")
+                    return
+            except Exception:
+                logger.debug("netbox_endpoints not available, skipping endpoint view registration")
+                return
+
+        try:
+            from django.shortcuts import render
+            from netbox.views import generic
+            from netbox_endpoints.models import Endpoint
+            from utilities.views import ViewTab, register_model_view
+
+            from .views import should_show_atlassian_tab_endpoint
+
+            @register_model_view(Endpoint, name="atlassian", path="atlassian")
+            class EndpointAtlassianView(generic.ObjectView):
+                """Display Jira issues and Confluence pages for an Endpoint."""
+
+                queryset = Endpoint.objects.all()
+                template_name = "netbox_atlassian/endpoint_tab.html"
+
+                tab = ViewTab(
+                    label="Atlassian",
+                    weight=9100,
+                    permission="netbox_endpoints.view_endpoint",
+                    hide_if_empty=False,
+                    visible=should_show_atlassian_tab_endpoint,
+                )
+
+                def get(self, request, pk):
+                    endpoint = Endpoint.objects.get(pk=pk)
+                    return render(
+                        request,
+                        self.template_name,
+                        {
+                            "object": endpoint,
+                            "tab": self.tab,
+                            "loading": True,
+                        },
+                    )
+
+            logger.info("Registered Atlassian tab for Endpoint model")
+        except ImportError:
+            logger.debug("netbox_endpoints not installed, skipping endpoint view registration")
+        except Exception as e:
+            logger.warning(f"Could not register endpoint views: {e}")
+
+
+config = AtlassianConfig

{netbox_atlassian-0.2.2 → netbox_atlassian-0.2.4}/netbox_atlassian/atlassian_client.py

@@ -219,22 +219,26 @@ class AtlassianClient:
         issues = []
         for issue in result.get("issues", []):
             fields = issue.get("fields", {})
-            issues.append({
-                "key": issue.get("key"),
-                "summary": fields.get("summary", ""),
-                "status": fields.get("status", {}).get("name", ""),
-                "status_category": fields.get("status", {}).get("statusCategory", {}).get("key", ""),
-                "type": fields.get("issuetype", {}).get("name", ""),
-                "type_icon": fields.get("issuetype", {}).get("iconUrl", ""),
-                "priority": fields.get("priority", {}).get("name", "") if fields.get("priority") else "",
-                "priority_icon": fields.get("priority", {}).get("iconUrl", "") if fields.get("priority") else "",
-                "assignee": fields.get("assignee", {}).get("displayName", "") if fields.get("assignee") else "Unassigned",
-                "created": fields.get("created", ""),
-                "updated": fields.get("updated", ""),
-                "project": fields.get("project", {}).get("name", ""),
-                "project_key": fields.get("project", {}).get("key", ""),
-                "url": f"{self.jira_url}/browse/{issue.get('key')}",
-            })
+            issues.append(
+                {
+                    "key": issue.get("key"),
+                    "summary": fields.get("summary", ""),
+                    "status": fields.get("status", {}).get("name", ""),
+                    "status_category": fields.get("status", {}).get("statusCategory", {}).get("key", ""),
+                    "type": fields.get("issuetype", {}).get("name", ""),
+                    "type_icon": fields.get("issuetype", {}).get("iconUrl", ""),
+                    "priority": fields.get("priority", {}).get("name", "") if fields.get("priority") else "",
+                    "priority_icon": fields.get("priority", {}).get("iconUrl", "") if fields.get("priority") else "",
+                    "assignee": (
+                        fields.get("assignee", {}).get("displayName", "") if fields.get("assignee") else "Unassigned"
+                    ),
+                    "created": fields.get("created", ""),
+                    "updated": fields.get("updated", ""),
+                    "project": fields.get("project", {}).get("name", ""),
+                    "project_key": fields.get("project", {}).get("key", ""),
+                    "url": f"{self.jira_url}/browse/{issue.get('key')}",
+                }
+            )
 
         response = {
             "issues": issues,
@@ -308,16 +312,18 @@ class AtlassianClient:
             ancestors = page.get("ancestors", [])
             breadcrumb = " > ".join([a.get("title", "") for a in ancestors])
 
-            pages.append({
-                "id": page.get("id"),
-                "title": page.get("title", ""),
-                "space_key": space.get("key", ""),
-                "space_name": space.get("name", ""),
-                "last_modified": version.get("when", ""),
-                "last_modified_by": version.get("by", {}).get("displayName", ""),
-                "breadcrumb": breadcrumb,
-                "url": f"{self.confluence_url}{page.get('_links', {}).get('webui', '')}",
-            })
+            pages.append(
+                {
+                    "id": page.get("id"),
+                    "title": page.get("title", ""),
+                    "space_key": space.get("key", ""),
+                    "space_name": space.get("name", ""),
+                    "last_modified": version.get("when", ""),
+                    "last_modified_by": version.get("by", {}).get("displayName", ""),
+                    "breadcrumb": breadcrumb,
+                    "url": f"{self.confluence_url}{page.get('_links', {}).get('webui', '')}",
+                }
+            )
 
         response = {
             "pages": pages,

netbox_atlassian-0.2.4/netbox_atlassian/templates/netbox_atlassian/endpoint_tab.html

@@ -0,0 +1,25 @@
+{% extends 'netbox_endpoints/endpoint.html' %}
+{% load helpers %}
+
+{% block content %}
+{% if loading %}
+<div id="atlassian-content"
+     hx-get="{% url 'plugins:netbox_atlassian:endpoint_content' pk=object.pk %}"
+     hx-trigger="load"
+     hx-swap="innerHTML">
+    <div class="d-flex justify-content-center align-items-center py-5">
+        <div class="text-center">
+            <div class="spinner-border text-primary mb-3" role="status" style="width: 3rem; height: 3rem;">
+                <span class="visually-hidden">Loading...</span>
+            </div>
+            <p class="text-muted mb-0">Loading Atlassian data...</p>
+            <p class="text-muted small">Searching Jira and Confluence</p>
+        </div>
+    </div>
+</div>
+{% elif error %}
+<div class="alert alert-warning">
+    <i class="mdi mdi-alert"></i> {{ error }}
+</div>
+{% endif %}
+{% endblock %}

{netbox_atlassian-0.2.2 → netbox_atlassian-0.2.4}/netbox_atlassian/urls.py

@@ -5,6 +5,7 @@ URL patterns for NetBox Atlassian Plugin
 from django.urls import path
 
 from .views import (
+    ENDPOINTS_PLUGIN_INSTALLED,
     AtlassianSettingsView,
     DeviceAtlassianContentView,
     TestConfluenceConnectionView,
@@ -19,3 +20,11 @@ urlpatterns = [
     path("device/<int:pk>/content/", DeviceAtlassianContentView.as_view(), name="device_content"),
     path("vm/<int:pk>/content/", VMAtlassianContentView.as_view(), name="vm_content"),
 ]
+
+# Add endpoint URLs if netbox_endpoints is installed
+if ENDPOINTS_PLUGIN_INSTALLED:
+    from .views import EndpointAtlassianContentView
+
+    urlpatterns.append(
+        path("endpoint/<int:pk>/content/", EndpointAtlassianContentView.as_view(), name="endpoint_content"),
+    )

{netbox_atlassian-0.2.2 → netbox_atlassian-0.2.4}/netbox_atlassian/views.py

@@ -22,6 +22,14 @@ from virtualization.models import VirtualMachine
 from .atlassian_client import get_client
 from .forms import AtlassianSettingsForm
 
+# Check if netbox_endpoints plugin is installed
+try:
+    from netbox_endpoints.models import Endpoint
+
+    ENDPOINTS_PLUGIN_INSTALLED = True
+except ImportError:
+    ENDPOINTS_PLUGIN_INSTALLED = False
+
 
 def get_device_attribute(device, attribute_path: str):
     """
@@ -354,3 +362,145 @@ class TestConfluenceConnectionView(View):
         if success:
             return JsonResponse({"success": True, "message": message})
         return JsonResponse({"success": False, "error": message}, status=400)
+
+
+# Endpoint-specific functions for netbox_endpoints plugin
+def get_endpoint_attribute(endpoint, attribute_path: str):
+    """
+    Get an endpoint attribute by dot-separated path.
+
+    Args:
+        endpoint: Endpoint instance
+        attribute_path: Dot-separated attribute path (e.g., "name", "mac_address")
+
+    Returns:
+        Attribute value or None if not found
+    """
+    try:
+        value = endpoint
+        for part in attribute_path.split("."):
+            value = getattr(value, part, None)
+            if value is None:
+                return None
+        # Convert to string for IP addresses and MAC
+        if hasattr(value, "ip"):
+            return str(value.ip)
+        return str(value) if value else None
+    except Exception:
+        return None
+
+
+def get_endpoint_search_terms(endpoint) -> list[str]:
+    """
+    Get search terms from endpoint based on configured endpoint_search_fields.
+
+    Returns list of non-empty values from enabled search fields.
+    """
+    config = settings.PLUGINS_CONFIG.get("netbox_atlassian", {})
+    search_fields = config.get(
+        "endpoint_search_fields",
+        [
+            {"name": "Name", "attribute": "name", "enabled": True},
+            {"name": "MAC Address", "attribute": "mac_address", "enabled": True},
+            {"name": "Serial", "attribute": "serial", "enabled": True},
+        ],
+    )
+
+    terms = []
+    for field in search_fields:
+        if not field.get("enabled", True):
+            continue
+
+        attribute = field.get("attribute", "")
+        if not attribute:
+            continue
+
+        value = get_endpoint_attribute(endpoint, attribute)
+        if value and value.strip():
+            # Split comma-separated values
+            if "," in value:
+                for part in value.split(","):
+                    part = part.strip()
+                    if part and part not in terms:
+                        terms.append(part)
+            else:
+                if value.strip() not in terms:
+                    terms.append(value.strip())
+
+    return terms
+
+
+def should_show_atlassian_tab_endpoint(endpoint) -> bool:
+    """
+    Determine if the Atlassian tab should be visible for this endpoint.
+
+    Shows tab if endpoint has at least one searchable field value.
+    """
+    if not ENDPOINTS_PLUGIN_INSTALLED:
+        return False
+
+    terms = get_endpoint_search_terms(endpoint)
+    return len(terms) > 0
+
+
+# Endpoint views - only available if netbox_endpoints is installed
+if ENDPOINTS_PLUGIN_INSTALLED:
+
+    class EndpointAtlassianContentView(LoginRequiredMixin, PermissionRequiredMixin, View):
+        """HTMX endpoint that returns Atlassian content for Endpoint async loading."""
+
+        permission_required = "netbox_endpoints.view_endpoint"
+
+        def get(self, request, pk):
+            """Fetch Atlassian data and return HTML content."""
+            endpoint = Endpoint.objects.get(pk=pk)
+
+            config = settings.PLUGINS_CONFIG.get("netbox_atlassian", {})
+            client = get_client()
+
+            # Get search terms from endpoint
+            search_terms = get_endpoint_search_terms(endpoint)
+
+            # Get configured search fields for display
+            search_fields = config.get(
+                "endpoint_search_fields",
+                [
+                    {"name": "Name", "attribute": "name", "enabled": True},
+                    {"name": "MAC Address", "attribute": "mac_address", "enabled": True},
+                    {"name": "Serial", "attribute": "serial", "enabled": True},
+                ],
+            )
+            enabled_fields = [f for f in search_fields if f.get("enabled", True)]
+
+            # Search Jira and Confluence
+            jira_results = {"issues": [], "total": 0, "error": None}
+            confluence_results = {"pages": [], "total": 0, "error": None}
+
+            if search_terms:
+                jira_max = config.get("jira_max_results", 10)
+                confluence_max = config.get("confluence_max_results", 10)
+
+                jira_results = client.search_jira(search_terms, max_results=jira_max)
+                confluence_results = client.search_confluence(search_terms, max_results=confluence_max)
+
+            # Get URLs for external links
+            jira_url = config.get("jira_url", "").rstrip("/")
+            confluence_url = config.get("confluence_url", "").rstrip("/")
+
+            return HttpResponse(
+                render_to_string(
+                    "netbox_atlassian/tab_content.html",
+                    {
+                        "object": endpoint,
+                        "search_terms": search_terms,
+                        "enabled_fields": enabled_fields,
+                        "jira_results": jira_results,
+                        "confluence_results": confluence_results,
+                        "jira_url": jira_url,
+                        "confluence_url": confluence_url,
+                        "jira_configured": bool(jira_url),
+                        "confluence_configured": bool(confluence_url),
+                    },
+                    request=request,
+                )
+            )

{netbox_atlassian-0.2.2 → netbox_atlassian-0.2.4}/netbox_atlassian.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: netbox-atlassian
-Version: 0.2.2
+Version: 0.2.4
 Summary: NetBox plugin to display Jira issues and Confluence pages related to devices
 Author-email: sieteunoseis <jeremy.worden@gmail.com>
 License: Apache-2.0

{netbox_atlassian-0.2.2 → netbox_atlassian-0.2.4}/netbox_atlassian.egg-info/SOURCES.txt

@@ -12,6 +12,7 @@ netbox_atlassian.egg-info/dependency_links.txt
 netbox_atlassian.egg-info/requires.txt
 netbox_atlassian.egg-info/top_level.txt
 netbox_atlassian/templates/netbox_atlassian/device_tab.html
+netbox_atlassian/templates/netbox_atlassian/endpoint_tab.html
 netbox_atlassian/templates/netbox_atlassian/settings.html
 netbox_atlassian/templates/netbox_atlassian/tab_content.html
 netbox_atlassian/templates/netbox_atlassian/vm_tab.html

{netbox_atlassian-0.2.2 → netbox_atlassian-0.2.4}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "netbox-atlassian"
-version = "0.2.2"
+version = "0.2.4"
 description = "NetBox plugin to display Jira issues and Confluence pages related to devices"
 readme = "README.md"
 license = {text = "Apache-2.0"}

netbox_atlassian-0.2.2/netbox_atlassian/__init__.py

@@ -1,74 +0,0 @@
-"""
-NetBox Atlassian Plugin
-
-Display Jira issues and Confluence pages related to devices in NetBox.
-Searches by configurable fields (hostname, serial, role, etc.) with OR logic.
-"""
-
-from netbox.plugins import PluginConfig
-
-__version__ = "0.2.2"
-
-
-class AtlassianConfig(PluginConfig):
-    """Plugin configuration for NetBox Atlassian integration."""
-
-    name = "netbox_atlassian"
-    verbose_name = "Atlassian"
-    description = "Display Jira issues and Confluence pages related to devices"
-    version = __version__
-    author = "sieteunoseis"
-    author_email = "sieteunoseis@github.com"
-    base_url = "atlassian"
-    min_version = "4.0.0"
-
-    # Required settings - plugin won't load without these
-    required_settings = []
-
-    # Default configuration values
-    default_settings = {
-        # Jira settings (on-prem)
-        "jira_url": "",  # e.g., "https://jira.example.com"
-        "jira_username": "",
-        "jira_password": "",  # or API token
-        "jira_token": "",  # Personal Access Token (PAT) - preferred for on-prem
-        "jira_verify_ssl": True,
-        # Confluence settings (on-prem)
-        "confluence_url": "",  # e.g., "https://confluence.example.com"
-        "confluence_username": "",
-        "confluence_password": "",  # or API token
-        "confluence_token": "",  # Personal Access Token (PAT) - preferred for on-prem
-        "confluence_verify_ssl": True,
-        # Cloud settings (for future use)
-        "use_cloud": False,
-        "cloud_api_token": "",
-        "cloud_email": "",
-        # Search configuration
-        # Fields to search - values are device attribute paths
-        # Searches use OR logic - matches any field
-        "search_fields": [
-            {"name": "Hostname", "attribute": "name", "enabled": True},
-            {"name": "Serial", "attribute": "serial", "enabled": True},
-            {"name": "Asset Tag", "attribute": "asset_tag", "enabled": False},
-            {"name": "Role", "attribute": "role.name", "enabled": False},
-            {"name": "Primary IP", "attribute": "primary_ip4.address", "enabled": False},
-        ],
-        # Jira search settings
-        "jira_max_results": 10,
-        "jira_projects": [],  # Empty = search all projects
-        "jira_issue_types": [],  # Empty = all types
-        # Confluence search settings
-        "confluence_max_results": 10,
-        "confluence_spaces": [],  # Empty = search all spaces
-        # General settings
-        "timeout": 30,
-        "cache_timeout": 300,  # Cache results for 5 minutes
-        # Enable legacy SSL renegotiation for older servers (required for OHSU wiki)
-        "enable_legacy_ssl": False,
-        # Device type filtering (like catalyst-center)
-        # Empty list = show tab for all devices
-        "device_types": [],  # e.g., ["cisco", "juniper"]
-    }
-
-
-config = AtlassianConfig