Add integration testing on Netbox 2.5/2.6

FragmentedPacket · web-flow · commit 6907af6c6522 · 2019-09-05T02:11:49.000-05:00
diff --git a/.travis.yml b/.travis.yml
@@ -1,38 +1,119 @@
 ---
-
 language: python
+services:
+  - docker
+
+sudo: false
+
+env:
+  global:
+    - COLLECTION_NAMESPACE: fragmentedpacket
+    - COLLECTION_NAME: netbox_modules
+    - COLLECTION_VERSION: 0.0.8
+
 matrix:
   include:
-    - name: "Python 3.6"
+    - name: "Python 3.6 - units"
       python: 3.6
       env: PYTHON_VER=3.6
-    - name: "Python 3.7"
+      install:
+        - pip install -U pip
+        - pip install pytest==4.6.5 pytest-mock pytest-xdist jinja2 PyYAML black==19.3b0
+        - cd ../../
+        # This is due to ansible-test only being available within devel branch
+        - git clone https://github.com/ansible/ansible.git
+        - cd ansible
+        - git checkout stable-2.9
+        - source hacking/env-setup
+        - cd ..
+      
+      before_script:
+        - mkdir -p ~/ansible_collections/$COLLECTION_NAMESPACE
+        - mv FragmentedPacket/$COLLECTION_NAME ~/ansible_collections/$COLLECTION_NAMESPACE/$COLLECTION_NAME
+        - cd ~/ansible_collections/$COLLECTION_NAMESPACE/$COLLECTION_NAME
+      
+      script:
+        - ansible-test units --python $PYTHON_VER -vvv
+        - black . --check
+
+    - name: "Python 3.7 - units"
       python: 3.7
       env: PYTHON_VER=3.7
-#python:
-#  - "3.6"
-#  - "3.7"
+      install:
+        - pip install -U pip
+        - pip install pytest==4.6.5 pytest-mock pytest-xdist jinja2 PyYAML black==19.3b0
+        - cd ../../
+        # This is due to ansible-test only being available within devel branch
+        - git clone https://github.com/ansible/ansible.git
+        - cd ansible
+        - git checkout stable-2.9
+        - source hacking/env-setup
+        - cd ..
 
-sudo: false
+      before_script:
+        - mkdir -p ~/ansible_collections/$COLLECTION_NAMESPACE
+        - mv FragmentedPacket/$COLLECTION_NAME ~/ansible_collections/$COLLECTION_NAMESPACE/$COLLECTION_NAME
+        - cd ~/ansible_collections/$COLLECTION_NAMESPACE/$COLLECTION_NAME
+      
+      script:
+        - ansible-test units --python $PYTHON_VER -vvv
+        - black . --check
 
-env:
-  global:
-    - COLLECTION_NAMESPACE: fragmentedpacket
-    - COLLECTION_NAME: netbox_modules
+    - name: "Python 3.6 / Netbox 2.5 - integration"
+      python: 3.6
+      # This is set and used by netbox-docker to pull the correct Netbox image
+      env: VERSION=v2.5
+      install:
+        - pip install -U pip
+        - pip install jinja2 PyYAML pynetbox==4.0.6 cryptography
+        - cd ../../
+        - git clone https://github.com/ansible/ansible.git
+        - cd ansible
+        - git checkout stable-2.9
+        - source hacking/env-setup
+        - cd ..
+        - git clone https://github.com/netbox-community/netbox-docker.git
+        - cd netbox-docker
+        - docker-compose --verbose pull
+        - docker-compose --verbose up -d
+        - cd ..
+
+      before_script:
+        - cd FragmentedPacket/netbox_modules
+        - mkdir ansible_collections
+        - ansible-galaxy collection build .
+        - ansible-galaxy collection install $COLLECTION_NAMESPACE-$COLLECTION_NAME-$COLLECTION_VERSION.tar.gz -p /home/travis/.ansible/collections
+
+      script:
+        - "sleep 60"
+        - python tests/integration/netbox-deploy.py
+        - ansible-playbook tests/integration/integration-tests.yml -v
+
+    - name: "Python 3.6 / Netbox 2.6 - integration"
+      python: 3.6
+      # This is set and used by netbox-docker to pull the correct Netbox image
+      env: VERSION=v2.6
+      install:
+        - pip install -U pip
+        - pip install jinja2 PyYAML pynetbox==4.0.6 cryptography
+        - cd ../../
+        - git clone https://github.com/ansible/ansible.git
+        - cd ansible
+        - git checkout stable-2.9
+        - source hacking/env-setup
+        - cd ..
+        - git clone https://github.com/netbox-community/netbox-docker.git
+        - cd netbox-docker
+        - docker-compose --verbose pull
+        - docker-compose --verbose up -d
+        - cd ..
+
+      before_script:
+        - cd FragmentedPacket/netbox_modules
+        - ansible-galaxy collection build .
+        - ansible-galaxy collection install $COLLECTION_NAMESPACE-$COLLECTION_NAME-$COLLECTION_VERSION.tar.gz -p /home/travis/.ansible/collections
 
-install:
-  - pip install -U pip
-  - pip install pytest==4.6.5 pytest-mock pytest-xdist jinja2 PyYAML black==19.3b0
-  - cd ../../
-  # This is due to ansible-test only being available within devel branch
-  - git clone https://github.com/ansible/ansible.git
-  - source ansible/hacking/env-setup
-
-before_script:
-  - mkdir -p ~/ansible_collections/$COLLECTION_NAMESPACE
-  - mv FragmentedPacket/$COLLECTION_NAME ~/ansible_collections/$COLLECTION_NAMESPACE/$COLLECTION_NAME
-  - cd ~/ansible_collections/$COLLECTION_NAMESPACE/$COLLECTION_NAME
-
-script:
-  - ansible-test units --python $PYTHON_VER
-  - black . --check
+      script:
+        - "sleep 60"
+        - python tests/integration/netbox-deploy.py
+        - ansible-playbook tests/integration/integration-tests.yml -v
diff --git a/README.md b/README.md
@@ -3,14 +3,14 @@
 
 **THIS IS A WIP DUE TO COLLECTIONS BEING IN TECH REVIEW CURRENTLY (Ansible 2.8) BUT WILL BE UPDATED AS NECESSARY AS COLLECTIONS MATURES**
 
-**TODO**
+## Todo
 - ~~initial build and changes to properly import module_utils~~
 - Add testing to Travis CI
-  - ~~Existing unit tests~~
+  - ~~Initial unit tests~~
   - ~~Test different Python versions (3.6/3.7)~~
+  - ~~Integration testing against at least two versions of Netbox~~
   - Local testing using Tox
   - Test currently supported versions of Ansible
-  - Integration testing against at least two versions of Netbox
 - ~~Add documentation on how to use to README~~
 - Add documentation on how to contribute to collection
 
@@ -24,7 +24,7 @@
 ## Existing Modules
 
  - netbox_device
- - netbox_interface
+ - netbox_device_interface
  - netbox_ip_address
  - netbox_prefix
  - netbox_site
diff --git a/galaxy.yml b/galaxy.yml
@@ -9,7 +9,7 @@ namespace: fragmentedpacket
 name: netbox_modules
 
 # The version of the collection. Must be compatible with semantic versioning
-version: 0.0.7
+version: 0.0.8
 
 # The path to the Markdown (.md) readme file. This path is relative to the root of the collection
 readme: README.md
diff --git a/plugins/module_utils/netbox_ipam.py b/plugins/module_utils/netbox_ipam.py
@@ -36,14 +36,21 @@ def _handle_state_new_present(self, nb_app, nb_endpoint, endpoint_name, name, da
             if self.state == "present":
                 self._ensure_object_exists(nb_endpoint, endpoint_name, name, data)
             elif self.state == "new":
-                self._create_netbox_object(nb_endpoint, data)
+                self.nb_object, diff = self._create_netbox_object(nb_endpoint, data)
+                self.result["msg"] = "%s %s created" % (endpoint_name, name)
+                self.result["changed"] = True
+                self.result["diff"] = diff
         else:
             if self.state == "present":
-                self._ensure_ip_in_prefix_present_on_netif(nb_app, nb_endpoint, data)
+                self._ensure_ip_in_prefix_present_on_netif(
+                    nb_app, nb_endpoint, data, endpoint_name
+                )
             elif self.state == "new":
-                self._get_new_available_ip_address(nb_app, data)
+                self._get_new_available_ip_address(nb_app, data, endpoint_name)
 
-    def _ensure_ip_in_prefix_present_on_netif(self, nb_app, nb_endpoint, data):
+    def _ensure_ip_in_prefix_present_on_netif(
+        self, nb_app, nb_endpoint, data, endpoint_name
+    ):
         """
         """
         if not data.get("interface") or not data.get("prefix"):
@@ -57,13 +64,14 @@ def _ensure_ip_in_prefix_present_on_netif(self, nb_app, nb_endpoint, data):
         if attached_ips:
             self.nb_object = attached_ips[-1].serialize()
             self.result["changed"] = False
-            self.result["msg"] = "IP Address %s already attached" % (
-                self.nb_object["address"]
+            self.result["msg"] = "%s %s already attached" % (
+                endpoint_name,
+                self.nb_object["address"],
             )
         else:
-            self._get_new_available_ip_address(nb_app, data)
+            self._get_new_available_ip_address(nb_app, data, endpoint_name)
 
-    def _get_new_available_ip_address(self, nb_app, data):
+    def _get_new_available_ip_address(self, nb_app, data, endpoint_name):
         prefix_query = self._build_query_params("prefix", data)
         prefix = nb_app.prefixes.get(**prefix_query)
         if not prefix:
@@ -76,24 +84,30 @@ def _get_new_available_ip_address(self, nb_app, data):
                 prefix.available_ips, data
             )
             self.result["changed"] = True
-            self.result["msg"] = "IP Address %s created" % (self.nb_object["address"])
+            self.result["msg"] = "%s %s created" % (
+                endpoint_name,
+                self.nb_object["address"],
+            )
             self.result["diff"] = diff
         else:
             self.result["changed"] = False
             self.result["msg"] = "No available IPs available within %s" % (
                 data["prefix"]
             )
 
-    def _get_new_available_prefix(self, data):
+    def _get_new_available_prefix(self, data, endpoint_name):
         if not self.nb_object:
             self.result["changed"] = False
-            self.result["msg"] = "Parent prefix does not exist: %s" % (data["parent"])
+            self.result["msg"] = "Parent prefix does not exist - %s" % (data["parent"])
         elif self.nb_object.available_prefixes.list():
             self.nb_object, diff = self._create_netbox_object(
                 self.nb_object.available_prefixes, data
             )
             self.result["changed"] = True
-            self.result["msg"] = "Prefix %s created" % (self.nb_object["prefix"])
+            self.result["msg"] = "%s %s created" % (
+                endpoint_name,
+                self.nb_object["prefix"],
+            )
             self.result["diff"] = diff
         else:
             self.result["changed"] = False
@@ -146,7 +160,7 @@ def run(self):
                 nb_app, nb_endpoint, endpoint_name, name, data
             )
         elif self.state == "present" and first_available and data.get("parent"):
-            self._get_new_available_prefix(data)
+            self._get_new_available_prefix(data, endpoint_name)
         elif self.state == "present":
             self._ensure_object_exists(nb_endpoint, endpoint_name, name, data)
         elif self.state == "absent":
diff --git a/plugins/modules/netbox_device_interface.py b/plugins/modules/netbox_device_interface.py
@@ -16,8 +16,8 @@
 
 DOCUMENTATION = r"""
 ---
-module: netbox_interface
-short_description: Creates or removes interfaces from Netbox
+module: netbox_device_interface
+short_description: Creates or removes interfaces on devices from Netbox
 description:
   - Creates or removes interfaces from Netbox
 notes:
@@ -127,23 +127,23 @@
   gather_facts: False
   tasks:
     - name: Create interface within Netbox with only required information
-      netbox_interface:
+      netbox_device_interface:
         netbox_url: http://netbox.local
         netbox_token: thisIsMyToken
         data:
           device: test100
           name: GigabitEthernet1
         state: present
     - name: Delete interface within netbox
-      netbox_interface:
+      netbox_device_interface:
         netbox_url: http://netbox.local
         netbox_token: thisIsMyToken
         data:
           device: test100
           name: GigabitEthernet1
         state: absent
     - name: Create LAG with several specified options
-      netbox_interface:
+      netbox_device_interface:
         netbox_url: http://netbox.local
         netbox_token: thisIsMyToken
         data:
@@ -155,7 +155,7 @@
           mode: Access
         state: present
     - name: Create interface and assign it to parent LAG
-      netbox_interface:
+      netbox_device_interface:
         netbox_url: http://netbox.local
         netbox_token: thisIsMyToken
         data:
@@ -170,7 +170,7 @@
           mode: Access
         state: present
     - name: Create interface as a trunk port
-      netbox_interface:
+      netbox_device_interface:
         netbox_url: http://netbox.local
         netbox_token: thisIsMyToken
         data:
@@ -224,8 +224,8 @@ def main():
 
     module = AnsibleModule(argument_spec=argument_spec, supports_check_mode=True)
 
-    netbox_interface = NetboxDcimModule(module, NB_INTERFACES)
-    netbox_interface.run()
+    netbox_device_interface = NetboxDcimModule(module, NB_INTERFACES)
+    netbox_device_interface.run()
 
 
 if __name__ == "__main__":
diff --git a/tests/integration/integration-tests.yml b/tests/integration/integration-tests.yml
diff --git a/tests/integration/netbox-deploy.py b/tests/integration/netbox-deploy.py
