netbox-atlassian 0.1.0__py3-none-any.whl

netbox_atlassian/views.py

@@ -0,0 +1,306 @@
+"""
+Views for NetBox Atlassian Plugin
+
+Registers custom tabs on Device detail views to show Jira issues and Confluence pages.
+Provides settings configuration UI.
+"""
+
+import re
+
+from dcim.models import Device
+from django.conf import settings
+from django.contrib import messages
+from django.http import JsonResponse
+from django.shortcuts import render
+from django.views import View
+from netbox.views import generic
+from utilities.views import ViewTab, register_model_view
+from virtualization.models import VirtualMachine
+
+from .atlassian_client import get_client
+from .forms import AtlassianSettingsForm
+
+
+def get_device_attribute(device, attribute_path: str):
+    """
+    Get a device attribute by dot-separated path.
+
+    Args:
+        device: Device instance
+        attribute_path: Dot-separated attribute path (e.g., "role.name", "primary_ip4.address")
+
+    Returns:
+        Attribute value or None if not found
+    """
+    try:
+        value = device
+        for part in attribute_path.split("."):
+            value = getattr(value, part, None)
+            if value is None:
+                return None
+        # Convert to string for IP addresses
+        if hasattr(value, "ip"):
+            return str(value.ip)
+        return str(value) if value else None
+    except Exception:
+        return None
+
+
+def get_search_terms(device) -> list[str]:
+    """
+    Get search terms from device based on configured search fields.
+
+    Returns list of non-empty values from enabled search fields.
+    """
+    config = settings.PLUGINS_CONFIG.get("netbox_atlassian", {})
+    search_fields = config.get("search_fields", [])
+
+    terms = []
+    for field in search_fields:
+        if not field.get("enabled", True):
+            continue
+
+        attribute = field.get("attribute", "")
+        if not attribute:
+            continue
+
+        value = get_device_attribute(device, attribute)
+        if value and value.strip():
+            terms.append(value.strip())
+
+    return terms
+
+
+def should_show_atlassian_tab(device) -> bool:
+    """
+    Determine if the Atlassian tab should be visible for this device.
+
+    Shows tab if:
+    - Device has at least one searchable field value
+    - Device type matches configured filters (if any)
+    """
+    config = settings.PLUGINS_CONFIG.get("netbox_atlassian", {})
+    device_types = config.get("device_types", [])
+
+    # Check device type filter if configured
+    if device_types and device.device_type:
+        manufacturer_slug = device.device_type.manufacturer.slug.lower() if device.device_type.manufacturer else ""
+        manufacturer_name = device.device_type.manufacturer.name.lower() if device.device_type.manufacturer else ""
+
+        matches = False
+        for pattern in device_types:
+            try:
+                if re.search(pattern.lower(), manufacturer_slug) or re.search(pattern.lower(), manufacturer_name):
+                    matches = True
+                    break
+            except re.error:
+                if pattern.lower() in manufacturer_slug or pattern.lower() in manufacturer_name:
+                    matches = True
+                    break
+
+        if not matches:
+            return False
+
+    # Check if we have any search terms
+    terms = get_search_terms(device)
+    return len(terms) > 0
+
+
+@register_model_view(Device, name="atlassian", path="atlassian")
+class DeviceAtlassianView(generic.ObjectView):
+    """Display Jira issues and Confluence pages for a Device."""
+
+    queryset = Device.objects.all()
+    template_name = "netbox_atlassian/device_tab.html"
+
+    tab = ViewTab(
+        label="Atlassian",
+        weight=9100,
+        permission="dcim.view_device",
+        hide_if_empty=False,
+    )
+
+    def get(self, request, pk):
+        """Handle GET request for the Atlassian tab."""
+        device = Device.objects.get(pk=pk)
+
+        config = settings.PLUGINS_CONFIG.get("netbox_atlassian", {})
+        client = get_client()
+
+        # Get search terms from device
+        search_terms = get_search_terms(device)
+
+        # Get configured search fields for display
+        search_fields = config.get("search_fields", [])
+        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 render(
+            request,
+            self.template_name,
+            {
+                "object": device,
+                "tab": self.tab,
+                "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),
+            },
+        )
+
+
+@register_model_view(VirtualMachine, name="atlassian", path="atlassian")
+class VirtualMachineAtlassianView(generic.ObjectView):
+    """Display Jira issues and Confluence pages for a VirtualMachine."""
+
+    queryset = VirtualMachine.objects.all()
+    template_name = "netbox_atlassian/vm_tab.html"
+
+    tab = ViewTab(
+        label="Atlassian",
+        weight=9100,
+        permission="virtualization.view_virtualmachine",
+        hide_if_empty=False,
+    )
+
+    def get(self, request, pk):
+        """Handle GET request for the Atlassian tab."""
+        vm = VirtualMachine.objects.get(pk=pk)
+
+        config = settings.PLUGINS_CONFIG.get("netbox_atlassian", {})
+        client = get_client()
+
+        # For VMs, search by name and primary IP
+        search_terms = []
+        if vm.name:
+            search_terms.append(vm.name)
+        if vm.primary_ip4:
+            search_terms.append(str(vm.primary_ip4.address.ip))
+
+        # Get configured search fields for display
+        search_fields = config.get("search_fields", [])
+        enabled_fields = [{"name": "Name", "attribute": "name", "enabled": True}]
+        if vm.primary_ip4:
+            enabled_fields.append({"name": "Primary IP", "attribute": "primary_ip4", "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 render(
+            request,
+            self.template_name,
+            {
+                "object": vm,
+                "tab": self.tab,
+                "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),
+            },
+        )
+
+
+class AtlassianSettingsView(View):
+    """View for configuring Atlassian plugin settings."""
+
+    template_name = "netbox_atlassian/settings.html"
+
+    def get_current_config(self):
+        """Get current plugin configuration."""
+        return settings.PLUGINS_CONFIG.get("netbox_atlassian", {})
+
+    def get(self, request):
+        """Display the settings form."""
+        config = self.get_current_config()
+        form = AtlassianSettingsForm(initial=config)
+
+        return render(
+            request,
+            self.template_name,
+            {
+                "form": form,
+                "config": config,
+            },
+        )
+
+    def post(self, request):
+        """Handle settings form submission."""
+        form = AtlassianSettingsForm(request.POST)
+
+        if form.is_valid():
+            messages.warning(
+                request,
+                "Settings must be configured in NetBox's configuration.py file. "
+                "See the README for configuration instructions.",
+            )
+        else:
+            messages.error(request, "Invalid settings provided.")
+
+        return render(
+            request,
+            self.template_name,
+            {
+                "form": form,
+                "config": self.get_current_config(),
+            },
+        )
+
+
+class TestJiraConnectionView(View):
+    """Test connection to Jira API."""
+
+    def post(self, request):
+        """Test the Jira connection and return result."""
+        client = get_client()
+        success, message = client.test_jira_connection()
+
+        if success:
+            return JsonResponse({"success": True, "message": message})
+        return JsonResponse({"success": False, "error": message}, status=400)
+
+
+class TestConfluenceConnectionView(View):
+    """Test connection to Confluence API."""
+
+    def post(self, request):
+        """Test the Confluence connection and return result."""
+        client = get_client()
+        success, message = client.test_confluence_connection()
+
+        if success:
+            return JsonResponse({"success": True, "message": message})
+        return JsonResponse({"success": False, "error": message}, status=400)

netbox_atlassian-0.1.0.dist-info/METADATA

@@ -0,0 +1,186 @@
+Metadata-Version: 2.4
+Name: netbox-atlassian
+Version: 0.1.0
+Summary: NetBox plugin to display Jira issues and Confluence pages related to devices
+Author-email: sieteunoseis <jeremy.worden@gmail.com>
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/sieteunoseis/netbox-atlassian
+Project-URL: Repository, https://github.com/sieteunoseis/netbox-atlassian
+Project-URL: Issues, https://github.com/sieteunoseis/netbox-atlassian/issues
+Keywords: netbox,jira,confluence,atlassian,plugin
+Classifier: Development Status :: 3 - Alpha
+Classifier: Framework :: Django
+Classifier: Intended Audience :: System Administrators
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: requests>=2.28.0
+Provides-Extra: dev
+Requires-Dist: black; extra == "dev"
+Requires-Dist: flake8; extra == "dev"
+Requires-Dist: isort; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+
+# NetBox Atlassian Plugin
+
+Display Jira issues and Confluence pages related to devices in NetBox.
+
+## Features
+
+- **Device Tab** - Shows Jira issues and Confluence pages mentioning device attributes
+- **VM Tab** - Same functionality for Virtual Machines
+- **Configurable Search Fields** - Search by hostname, serial, asset tag, role, IP, etc.
+- **OR Search Logic** - Finds content matching any configured field
+- **On-Premise Support** - Works with Jira Server/Data Center and Confluence Server/Data Center
+- **Cloud Ready** - Prepared for Atlassian Cloud (future release)
+- **Caching** - Results cached to reduce API calls
+- **Project/Space Filtering** - Limit searches to specific Jira projects or Confluence spaces
+
+## Requirements
+
+- NetBox 4.0+
+- Python 3.10+
+- Access to Jira and/or Confluence REST APIs
+
+## Installation
+
+```bash
+pip install netbox-atlassian
+```
+
+Add to `configuration.py`:
+
+```python
+PLUGINS = [
+    "netbox_atlassian",
+]
+```
+
+## Configuration
+
+```python
+PLUGINS_CONFIG = {
+    "netbox_atlassian": {
+        # Jira settings (on-prem)
+        "jira_url": "https://jira.example.com",
+        "jira_username": "api_user",
+        "jira_password": "api_token_or_password",
+        "jira_verify_ssl": True,
+        "jira_projects": [],  # Empty = all projects
+
+        # Confluence settings (on-prem)
+        "confluence_url": "https://confluence.example.com",
+        "confluence_username": "api_user",
+        "confluence_password": "api_token_or_password",
+        "confluence_verify_ssl": True,
+        "confluence_spaces": [],  # Empty = all spaces
+
+        # Search configuration
+        "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},
+        ],
+
+        # Results limits
+        "jira_max_results": 10,
+        "confluence_max_results": 10,
+
+        # General
+        "timeout": 30,
+        "cache_timeout": 300,
+        "device_types": [],  # Filter by manufacturer (empty = all)
+    }
+}
+```
+
+## Search Fields
+
+The `search_fields` configuration defines which device attributes are searched. Searches use **OR logic** - content matching any enabled field will be returned.
+
+| Field | Attribute Path | Description |
+|-------|---------------|-------------|
+| Hostname | `name` | Device name |
+| Serial | `serial` | Serial number |
+| Asset Tag | `asset_tag` | Asset tag |
+| Role | `role.name` | Device role name |
+| Primary IP | `primary_ip4.address` | Primary IPv4 address |
+| Site | `site.name` | Site name |
+| Tenant | `tenant.name` | Tenant name |
+
+### Custom Fields
+
+You can search custom fields using dot notation:
+
+```python
+{"name": "CMDB ID", "attribute": "custom_field_data.cmdb_id", "enabled": True}
+```
+
+## Screenshots
+
+### Device Tab
+Shows Jira issues and Confluence pages in a split view:
+- Left: Jira issues with key, summary, status, and type
+- Right: Confluence pages with title, space, and breadcrumb
+
+### Settings Page
+View current configuration and test connections to Jira/Confluence.
+
+## API Endpoints
+
+The plugin adds these endpoints:
+
+| Endpoint | Method | Description |
+|----------|--------|-------------|
+| `/plugins/atlassian/settings/` | GET | View settings |
+| `/plugins/atlassian/test-jira/` | POST | Test Jira connection |
+| `/plugins/atlassian/test-confluence/` | POST | Test Confluence connection |
+
+## Troubleshooting
+
+### Connection Errors
+
+1. Verify URLs are correct and accessible from NetBox server
+2. Check username/password or API token
+3. For on-prem, ensure `verify_ssl` matches your certificate setup
+4. Check firewall rules allow outbound HTTPS
+
+### No Results
+
+1. Verify search fields are enabled in configuration
+2. Check that Jira/Confluence content contains the device attributes
+3. Review project/space filters if configured
+4. Check API user has read permissions
+
+### Slow Performance
+
+1. Increase `cache_timeout` to reduce API calls
+2. Reduce `max_results` values
+3. Use project/space filters to limit search scope
+
+## Development
+
+```bash
+git clone https://github.com/sieteunoseis/netbox-atlassian.git
+cd netbox-atlassian
+pip install -e ".[dev]"
+
+# Run linting
+black netbox_atlassian/
+isort netbox_atlassian/
+flake8 netbox_atlassian/
+```
+
+## License
+
+Apache 2.0
+
+## Author
+
+sieteunoseis

netbox_atlassian-0.1.0.dist-info/RECORD

@@ -0,0 +1,13 @@
+netbox_atlassian/__init__.py,sha256=caHvJRtHTHUx1tRKQyNXzYvMihUJ71fFWkJPqgunTIs,2754
+netbox_atlassian/atlassian_client.py,sha256=oO4maq4AWknbf-HEin72BS30gM7HcRsunC0xv9O9YUI,12859
+netbox_atlassian/forms.py,sha256=b8MKsU3Ou-c0s7Cga_72m7E3UCCliZF-17woybN66dk,3385
+netbox_atlassian/navigation.py,sha256=tpRgS8qESmxm5eEuCOd1UjEVXEDTMM12H4lEaZk1BRw,497
+netbox_atlassian/urls.py,sha256=kIiL-G8wfMd1tdSrnWeWcTuHZMx6CCc5mLr_WjKn8Rs,454
+netbox_atlassian/views.py,sha256=EQlU2hcHNcRfwsD5C73L1X5u82WeB26XqSPcMVxl9S4,10118
+netbox_atlassian/templates/netbox_atlassian/device_tab.html,sha256=Vs1QMlCa6vcWF0HrL1VlV6mHrl9iaCC_R3IsjH1BcJQ,9521
+netbox_atlassian/templates/netbox_atlassian/settings.html,sha256=bmiIzzJ6m1vwT5AOcOrdJ7uD3V31GbKUpT4M6TIP3wE,11709
+netbox_atlassian/templates/netbox_atlassian/vm_tab.html,sha256=Q_Psv-08lyLys_CAF4oJvAUIWcg_2OnkcMFbdnKg8vk,9539
+netbox_atlassian-0.1.0.dist-info/METADATA,sha256=Zw0phWkrxAmDEXe0oySURhi5xLQ7RRBamQcpXqDIlfY,5675
+netbox_atlassian-0.1.0.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
+netbox_atlassian-0.1.0.dist-info/top_level.txt,sha256=VaKVLTW0o2SE7896PzRTWUaEeYt8CWsryBXI6Ij4ECg,17
+netbox_atlassian-0.1.0.dist-info/RECORD,,

netbox_atlassian-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.10.2)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

netbox_atlassian-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+netbox_atlassian