netbox-cesnet-services-plugin 1.0.0__tar.gz

netbox_cesnet_services_plugin-1.0.0/CONTRIBUTING.md

@@ -0,0 +1,128 @@
+# Contributing
+
+Contributions are welcome, and they are greatly appreciated! Every little bit
+helps, and credit will always be given.
+
+We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:
+
+- Reporting a bug
+- Discussing the current state of the code
+- Submitting a fix
+- Proposing new features
+- Becoming a maintainer
+
+## General Tips for Working on GitHub
+
+* Register for a free [GitHub account](https://github.com/signup) if you haven't already.
+* You can use [GitHub Markdown](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax) for formatting text and adding images.
+* To help mitigate notification spam, please avoid "bumping" issues with no activity. (To vote an issue up or down, use a :thumbsup: or :thumbsdown: reaction.)
+* Please avoid pinging members with `@` unless they've previously expressed interest or involvement with that particular issue.
+* Familiarize yourself with [this list of discussion anti-patterns](https://github.com/bradfitz/issue-tracker-behaviors) and make every effort to avoid them.
+
+## Types of Contributions
+
+### Report Bugs
+
+Report bugs at https://github.com/kani999/netbox_cesnet_services_plugin/issues.
+
+If you are reporting a bug, please include:
+
+* Your operating system name and version.
+* Any details about your local setup that might be helpful in troubleshooting.
+* Detailed steps to reproduce the bug.
+
+### Fix Bugs
+
+Look through the GitHub issues for bugs. Anything tagged with "bug" and "help
+wanted" is open to whoever wants to implement it.
+
+### Implement Features
+
+Look through the GitHub issues for features. Anything tagged with "enhancement"
+and "help wanted" is open to whoever wants to implement it.
+
+### Write Documentation
+
+NetBox cesnet_services Plugin could always use more documentation, whether as part of the
+official NetBox cesnet_services Plugin docs, in docstrings, or even on the web in blog posts,
+articles, and such.
+
+### Submit Feedback
+
+The best way to send feedback is to file an issue at https://github.com/kani999/netbox_cesnet_services_plugin/issues.
+
+If you are proposing a feature:
+
+* Explain in detail how it would work.
+* Keep the scope as narrow as possible, to make it easier to implement.
+* Remember that this is a volunteer-driven project, and that contributions
+  are welcome :)
+
+## Get Started!
+
+Ready to contribute? Here's how to set up `netbox_cesnet_services_plugin` for local development.
+
+1. Fork the `netbox_cesnet_services_plugin` repo on GitHub.
+2. Clone your fork locally
+
+    ```
+    $ git clone git@github.com:your_name_here/netbox_cesnet_services_plugin.git
+    ```
+
+3. Install dependencies and start your virtualenv:
+
+    ```
+    $ poetry install -E test -E doc -E dev
+    ```
+
+4. Create a branch for local development:
+
+    ```
+    $ git checkout -b name-of-your-bugfix-or-feature
+    ```
+
+    Now you can make your changes locally.
+
+5. When you're done making changes, check that your changes pass the
+   tests, including testing other Python versions, with tox:
+
+    ```
+    $ poetry run tox
+    ```
+
+6. Commit your changes and push your branch to GitHub:
+
+    ```
+    $ git add .
+    $ git commit -m "Your detailed description of your changes."
+    $ git push origin name-of-your-bugfix-or-feature
+    ```
+
+7. Submit a pull request through the GitHub website.
+
+## Pull Request Guidelines
+
+Before you submit a pull request, check that it meets these guidelines:
+
+1. The pull request should include tests.
+2. If the pull request adds functionality, the docs should be updated. Put
+   your new functionality into a function with a docstring, and add the
+   feature to the list in README.md.
+3. The pull request should work for Python 3.6, 3.7, 3.8 and 3.9. Check
+   https://github.com/kani999/netbox_cesnet_services_plugin/actions
+   and make sure that the tests pass for all supported Python versions.
+
+
+## Deploying
+
+A reminder for the maintainers on how to deploy.
+Make sure all your changes are committed (including an entry in CHANGELOG.md).
+Then run:
+
+```
+$ poetry run bump2version patch # possible: major / minor / patch
+$ git push
+$ git push --tags
+```
+
+GitHub Actions will then deploy to PyPI if tests pass.

netbox_cesnet_services_plugin-1.0.0/LICENSE

@@ -0,0 +1 @@
+

netbox_cesnet_services_plugin-1.0.0/MANIFEST.in

@@ -0,0 +1,10 @@
+include CONTRIBUTING.md
+include LICENSE
+include README.md
+
+recursive-include tests *
+recursive-exclude * __pycache__
+recursive-exclude * *.py[co]
+
+recursive-include docs *.rst conf.py Makefile make.bat *.jpg *.png *.gif
+recursive-include netbox_cesnet_services_plugin/templates *

netbox_cesnet_services_plugin-1.0.0/PKG-INFO

@@ -0,0 +1,12 @@
+Metadata-Version: 2.1
+Name: netbox_cesnet_services_plugin
+Version: 1.0.0
+Summary: NetBox plugin for cesnet_services.
+Home-page: UNKNOWN
+Author: Jan Krupa
+License: MIT
+Platform: UNKNOWN
+License-File: LICENSE
+
+UNKNOWN
+

netbox_cesnet_services_plugin-1.0.0/README.md

@@ -0,0 +1,61 @@
+# NetBox cesnet_services Plugin
+
+NetBox plugin for cesnet_services.
+
+
+* Free software: Apache-2.0
+* Documentation: https://kani999.github.io/netbox-cesnet-services-plugin/
+
+
+## Features
+
+The features the plugin provides should be listed here.
+
+## Compatibility
+
+| NetBox Version | Plugin Version |
+|----------------|----------------|
+|     3.4        |      0.1.0     |
+
+## Installing
+
+For adding to a NetBox Docker setup see
+[the general instructions for using netbox-docker with plugins](https://github.com/netbox-community/netbox-docker/wiki/Using-Netbox-Plugins).
+
+While this is still in development and not yet on pypi you can install with pip:
+
+```bash
+pip install git+https://github.com/kani999/netbox_cesnet_services_plugin
+```
+
+or by adding to your `local_requirements.txt` or `plugin_requirements.txt` (netbox-docker):
+
+```bash
+git+https://github.com/kani999/netbox_cesnet_services_plugin
+```
+
+Enable the plugin in `/opt/netbox/netbox/netbox/configuration.py`,
+ or if you use netbox-docker, your `/configuration/plugins.py` file :
+
+Set device platforms for filtering choices in LLDPNeighbor form. 
+
+```python
+PLUGINS = [
+    'netbox_cesnet_services_plugin'
+]
+
+PLUGINS_CONFIG = {
+    "netbox_cesnet_services_plugin": {
+        "platforms" : ["ios", "iosxe", "iosxr", "nxos", "nxos_ssh"],
+    },
+}
+```
+
+## Credits
+
+Based on the NetBox plugin tutorial:
+
+- [demo repository](https://github.com/netbox-community/netbox-plugin-demo)
+- [tutorial](https://github.com/netbox-community/netbox-plugin-tutorial)
+
+This package was created with [Cookiecutter](https://github.com/audreyr/cookiecutter) and the [`netbox-community/cookiecutter-netbox-plugin`](https://github.com/netbox-community/cookiecutter-netbox-plugin) project template.

netbox_cesnet_services_plugin-1.0.0/netbox_cesnet_services_plugin/__init__.py

@@ -0,0 +1,19 @@
+"""Top-level package for NetBox cesnet_services Plugin."""
+
+__author__ = """Jan Krupa"""
+__email__ = "jan.krupa@cesnet.cz"
+__version__ = "0.1.0"
+
+
+from netbox.plugins import PluginConfig
+
+
+class CesnetServicesConfig(PluginConfig):
+    name = "netbox_cesnet_services_plugin"
+    verbose_name = "NetBox cesnet_services Plugin"
+    description = "NetBox plugin for cesnet_services."
+    version = __version__
+    base_url = "netbox-cesnet-services-plugin"
+
+
+config = CesnetServicesConfig

netbox_cesnet_services_plugin-1.0.0/netbox_cesnet_services_plugin/api/serializers.py

@@ -0,0 +1,123 @@
+from ipam.api.serializers import IPAddressSerializer, PrefixSerializer, VRFSerializer
+from dcim.api.serializers import DeviceSerializer, InterfaceSerializer
+from netbox.api.serializers import NetBoxModelSerializer
+from rest_framework import serializers
+
+from netbox_cesnet_services_plugin.models import BGPConnection, LLDPNeighbor, LLDPNeighborLeaf
+
+
+
+
+class LLDPNeighborLeafSerializer(NetBoxModelSerializer):
+    url = serializers.HyperlinkedIdentityField(
+        view_name="plugins-api:netbox_cesnet_services_plugin-api:lldpneighborleaf-detail"
+    )
+    device_nb = DeviceSerializer(nested=True)
+    interface_nb = InterfaceSerializer(nested=True)
+    
+    class Meta:
+        model = LLDPNeighborLeaf
+        fields = (
+            "id",
+            "url",
+            "device_nb",
+            "interface_nb",
+            "device_ext",
+            "interface_ext",
+            "status",
+            "comments",
+            "tags",
+            "imported_data",
+            "custom_fields",
+            "created",
+            "last_updated",
+        )
+        brief_fields = (
+            "id",
+            "device_nb",
+            "interface_nb",
+            "device_ext",
+            "interface_ext",
+            "status",
+        )
+
+
+
+class LLDPNeighborSerializer(NetBoxModelSerializer):
+    url = serializers.HyperlinkedIdentityField(
+        view_name="plugins-api:netbox_cesnet_services_plugin-api:lldpneighbor-detail"
+    )
+    device_a = DeviceSerializer(nested=True)
+    interface_a = InterfaceSerializer(nested=True)
+    device_b = DeviceSerializer(nested=True)
+    interface_b = InterfaceSerializer(nested=True)
+
+    class Meta:
+        model = LLDPNeighbor
+        fields = (
+            "id",
+            "url",
+            "device_a",
+            "interface_a",
+            "device_b",
+            "interface_b",
+            "status",
+            "comments",
+            "tags",
+            "imported_data",
+            "custom_fields",
+            "created",
+            "last_updated",
+        )
+        brief_fields = (
+            "id",
+            "device_a",
+            "interface_a",
+            "device_b",
+            "interface_b",
+            "status",
+        )
+
+
+class BGPConnectionSerializer(NetBoxModelSerializer):
+    url = serializers.HyperlinkedIdentityField(
+        view_name="plugins-api:netbox_cesnet_services_plugin-api:bgpconnection-detail"
+    )
+    device = DeviceSerializer(nested=True)
+    next_hop = IPAddressSerializer(nested=True, allow_null=True)
+    bgp_prefix = PrefixSerializer(nested=True, allow_null=True)
+    vrf = VRFSerializer(nested=True, allow_null=True)
+
+    class Meta:
+        model = BGPConnection
+        fields = (
+            "id",
+            "display",
+            "url",
+            "device",
+            "raw_next_hop",
+            "next_hop",
+            "raw_bgp_prefix",
+            "bgp_prefix",
+            "raw_vrf",
+            "vrf",
+            "role",
+            "tags",
+            "import_data",
+            "custom_fields",
+            "created",
+            "last_updated",
+        )
+        brief_fields = (
+            "id",
+            "url",
+            "display",
+            "device",
+            "raw_next_hop",
+            "next_hop",
+            "raw_bgp_prefix",
+            "bgp_prefix",
+            "raw_vrf",
+            "vrf",
+            "role",
+        )

netbox_cesnet_services_plugin-1.0.0/netbox_cesnet_services_plugin/api/urls.py

@@ -0,0 +1,11 @@
+from netbox.api.routers import NetBoxRouter
+
+from . import views
+
+app_name = 'netbox_cesnet_services_plugin'
+router = NetBoxRouter()
+router.register('bgp-connections', views.BGPConnectionViewSet)
+router.register('lldp-neighbors', views.LLDPNeighborViewSet)
+router.register('lldp-neighbor-leafs', views.LLDPNeighborLeafViewSet)
+
+urlpatterns = router.urls

netbox_cesnet_services_plugin-1.0.0/netbox_cesnet_services_plugin/api/views.py

@@ -0,0 +1,26 @@
+from netbox.api.metadata import ContentTypeMetadata
+from netbox.api.viewsets import NetBoxModelViewSet
+
+from netbox_cesnet_services_plugin import filtersets, models
+from .serializers import BGPConnectionSerializer, LLDPNeighborSerializer, LLDPNeighborLeafSerializer
+
+
+class BGPConnectionViewSet(NetBoxModelViewSet):
+    metadata_class = ContentTypeMetadata
+    queryset = models.BGPConnection.objects.all()
+    serializer_class = BGPConnectionSerializer
+    filterset_class = filtersets.BGPConnectionFilterSet
+
+
+class LLDPNeighborViewSet(NetBoxModelViewSet):
+    metadata_class = ContentTypeMetadata
+    queryset = models.LLDPNeighbor.objects.all()
+    serializer_class = LLDPNeighborSerializer
+    filterset_class = filtersets.LLPDNeighborFilterSet
+
+
+class LLDPNeighborLeafViewSet(NetBoxModelViewSet):
+    metadata_class = ContentTypeMetadata
+    queryset = models.LLDPNeighborLeaf.objects.all()
+    serializer_class = LLDPNeighborLeafSerializer
+    filterset_class = filtersets.LLPDNeighborLeafFilterSet

netbox_cesnet_services_plugin-1.0.0/netbox_cesnet_services_plugin/choices.py

@@ -0,0 +1,12 @@
+from utilities.choices import ChoiceSet
+from django.utils.translation import gettext_lazy as _
+
+class LLDPNeigborStatusChoices(ChoiceSet):
+
+    STATUS_ACTIVE = 'active'
+    STATUS_INACTIVE = 'inactive'
+    
+    CHOICES = (
+        (STATUS_ACTIVE, _('Active'), 'green'),
+        (STATUS_INACTIVE, _('Inactive'), 'yellow'),
+    )

netbox_cesnet_services_plugin-1.0.0/netbox_cesnet_services_plugin/filtersets/__init__.py

@@ -0,0 +1,3 @@
+from .bgpconnection import *
+from .lldpneighbor import *
+from .lldpneighborleaf import *

netbox_cesnet_services_plugin-1.0.0/netbox_cesnet_services_plugin/filtersets/bgpconnection.py

@@ -0,0 +1,88 @@
+from django.db.models import Q
+from django.utils.translation import gettext as _
+import django_filters
+from netbox.filtersets import NetBoxModelFilterSet
+from ipam.models import IPAddress, Prefix, VRF
+from extras.filters import TagFilter
+from netbox_cesnet_services_plugin.models import BGPConnection, BGPConnectionChoices
+from utilities.forms.fields import DynamicMultipleChoiceField
+from dcim.models import Device
+
+
+class BGPConnectionFilterSet(NetBoxModelFilterSet):
+    q = django_filters.CharFilter(method="search", label="Search")
+    device = django_filters.ModelMultipleChoiceFilter(queryset=Device.objects.all())
+    next_hop = django_filters.ModelMultipleChoiceFilter(
+        queryset=IPAddress.objects.all()
+    )
+    bgp_prefix = django_filters.ModelMultipleChoiceFilter(queryset=Prefix.objects.all())
+    vrf = django_filters.ModelMultipleChoiceFilter(queryset=VRF.objects.all())
+
+    # TODO: as CHAR filter or as IPAddress filter?
+    raw_next_hop = django_filters.CharFilter(
+        # method='filter_address',
+        label=_("Address"),
+        lookup_expr="icontains",
+    )
+    raw_bgp_prefix = django_filters.CharFilter(
+        # method='filter_prefix',
+        label=_("Prefix"),
+        lookup_expr="icontains",
+    )
+    raw_vrf = django_filters.CharFilter(
+        label=_("VRF"),
+    )
+
+    role = DynamicMultipleChoiceField(choices=BGPConnectionChoices, required=False)
+
+    tag = TagFilter()
+
+    class Meta:
+        model = BGPConnection
+        fields = [
+            "raw_next_hop",
+            "next_hop",
+            "raw_bgp_prefix",
+            "bgp_prefix",
+            "vrf",
+            "role",
+            "tag",
+        ]
+
+    def search(self, queryset, name, value):
+        filters = (
+            Q(device__name=value)
+            | Q(raw_next_hop__icontains=value)
+            | Q(raw_bgp_prefix__icontains=value)
+            | Q(bgp_prefix__tenant__name__icontains=value)
+            | Q(raw_vrf__icontains=value)
+            | Q(vrf__name__icontains=value)
+            | Q(role__icontains=value)
+        )
+
+        return queryset.filter(filters)
+
+    # TODO: Filter `raw`` Address and Prefix with netaddr or treat it like a string?
+    """
+    def filter_address(self, queryset, name, value):
+        # Let's first parse the addresses passed
+        # as argument. If they are all invalid,
+        # we return an empty queryset
+        # TODO: Use Netaddr or ipaddress module
+        value = self.parse_inet_addresses(value)
+        if len(value) == 0:
+            return queryset.none()
+        try:
+            return queryset.filter(address__net_in=value)
+        except ValidationError:
+            return queryset.none()
+
+    def filter_prefix(self, queryset, name, value):
+        query_values = []
+        for v in value:
+            try:
+                query_values.append(netaddr.IPNetwork(v))
+            except (AddrFormatError, ValueError):
+                pass
+        return queryset.filter(prefix__in=query_values)
+    """

netbox_cesnet_services_plugin-1.0.0/netbox_cesnet_services_plugin/filtersets/lldpneighbor.py

@@ -0,0 +1,69 @@
+from django.db.models import Q
+import django_filters
+from extras.filters import TagFilter
+from netbox.filtersets import NetBoxModelFilterSet
+from dcim.models import Device, Interface
+from netbox_cesnet_services_plugin.models import LLDPNeighbor
+
+
+class LLPDNeighborFilterSet(NetBoxModelFilterSet):
+    q = django_filters.CharFilter(method="search", label="Search")
+    device_a = django_filters.ModelMultipleChoiceFilter(queryset=Device.objects.all())
+    interface_a = django_filters.ModelMultipleChoiceFilter(
+        queryset=Interface.objects.all()
+    )
+    device_b = django_filters.ModelMultipleChoiceFilter(queryset=Device.objects.all())
+    interface_b = django_filters.ModelMultipleChoiceFilter(
+        queryset=Interface.objects.all()
+    )
+
+    device_a_id = django_filters.ModelMultipleChoiceFilter(
+        field_name='device_a__id',
+        queryset=Device.objects.all(),
+        to_field_name='id',
+        label='Device (ID)',
+    )
+    device_b_id = django_filters.ModelMultipleChoiceFilter(
+        field_name='device_b__id',
+        queryset=Device.objects.all(),
+        to_field_name='id',
+        label='Device (ID)',
+    )
+    interface_a_id = django_filters.ModelMultipleChoiceFilter(
+        field_name='interface_a__id',
+        queryset=Interface.objects.all(),
+        to_field_name='id',
+        label='Interface (ID)',
+    )
+    interface_b_id = django_filters.ModelMultipleChoiceFilter(
+        field_name='interface_b__id',
+        queryset=Interface.objects.all(),
+        to_field_name='id',
+        label='Interface (ID)',
+    )
+
+    tag = TagFilter()
+
+    class Meta:
+        model = LLDPNeighbor
+        fields = {"id",
+                  "device_a",
+                  "interface_a",
+                  "device_b",
+                  "interface_b",
+                  "status",
+                  "device_a_id",
+                  "device_b_id",
+                  "interface_a_id",
+                  "interface_b_id",
+                  }
+
+    def search(self, queryset, name, value):
+        filters = (
+            Q(device_a__name__icontains=value)
+            | Q(device_b__name__icontains=value)
+            | Q(interface_a__name__icontains=value)
+            | Q(interface_a__name__icontains=value)
+        )
+
+        return queryset.filter(filters)

netbox_cesnet_services_plugin-1.0.0/netbox_cesnet_services_plugin/filtersets/lldpneighborleaf.py

@@ -0,0 +1,27 @@
+import django_filters
+from django.db.models import Q
+from netbox.filtersets import NetBoxModelFilterSet
+from dcim.models import Device, Interface
+from netbox_cesnet_services_plugin.models import LLDPNeighborLeaf
+
+
+class LLPDNeighborLeafFilterSet(NetBoxModelFilterSet):
+    q = django_filters.CharFilter(method="search", label="Search")
+    device_nb = django_filters.ModelMultipleChoiceFilter(queryset=Device.objects.all())
+    interface_nb = django_filters.ModelMultipleChoiceFilter(
+        queryset=Interface.objects.all()
+    )
+
+    class Meta:
+        model = LLDPNeighborLeaf
+        fields = {"id", "device_nb", "interface_nb", "device_ext", "interface_ext", "status"}
+
+    def search(self, queryset, name, value):
+        filters = (
+            Q(device_nb__name__icontains=value)
+            | Q(interface_nb__name__icontains=value)
+            | Q(device_ext__icontains=value)
+            | Q(interface_ext__icontains=value)
+        )
+
+        return queryset.filter(filters)

netbox_cesnet_services_plugin-1.0.0/netbox_cesnet_services_plugin/forms/__init__.py

@@ -0,0 +1,3 @@
+from .bgpconnection import *
+from .lldpneighbor import *
+from .lldpneighborleaf import *