Initial commit to test collection

Author: FragmentedPacket

.gitignore

@@ -0,0 +1,4 @@
+*.tar.gz
+__pycache__/
+*.pyc
+tests/output/*

.travis.yml

@@ -0,0 +1,30 @@
+---
+
+language: python
+
+python:
+  - "3.6"
+
+sudo: false
+
+env:
+  global:
+    - COLLECTION_NAMESPACE: fragmentedpacket
+    - COLLECTION_NAME: netbox_modules
+
+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 3.6 
+  - black . --check

README.md

@@ -1,2 +1,66 @@
-# netbox_modules
-Netbox modules for Ansible using Ansible Collections
+# Netbox modules for Ansible using Ansible Collections 
+  
+**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:
+- ~~initial build and changes to properly import module_utils~~
+- Add testing to a CI (Travis?) and existing unit tests
+  - ~~Initial unit tests~~
+  - Test different Python versions (3.6/3.7)
+  - Local testing using Tox
+  - Test currently supported versions of Ansible
+- ~~Add documentation on how to use to README~~
+- Add documentation on how to contribute to collection
+
+## Requirements
+- Ansible 2.9+
+  - Or run Ansible via source
+- Python 3.6+
+
+## Existing Modules
+
+ - netbox_device
+ - netbox_interface
+ - netbox_ip_address
+ - netbox_prefix
+ - netbox_site
+
+## How to Use
+- Install via Mazer
+  - `mazer install fragmentedpacket.netbox_modules`
+- Follow Ansible instructions to use the collection:
+  - [https://docs.ansible.com/ansible/devel/dev_guide/collections_tech_preview.html#using-collections](https://docs.ansible.com/ansible/devel/dev_guide/collections_tech_preview.html#using-collections)
+
+#### Example playbook
+```yaml
+- name: "Test Netbox modules"
+  connection: local
+  hosts: localhost
+  gather_facts: False
+  collections:
+    - fragmentedpacket.netbox_modules
+
+  tasks:
+    - name: Create device within Netbox with only required information
+      netbox_device:
+        netbox_url: http://netbox-demo.org:32768
+        netbox_token: 0123456789abcdef0123456789abcdef01234567
+        data:
+          name: Test66
+          device_type: Cisco Test
+          device_role: Core Switch
+          site: Test Site
+          status: Staged
+          state: present
+```
+
+## How to Contribute
+**Will be updated with diagram and more information needed to contribute**
+
+If looking to contribute before this is updated, please review the code and hopefully it is enough to get started on adding new modules and how the new modules should be structured.
+
+#### Testing
+
+ 1. Please update `tests/unit/module_utils/test_netbox_base_class.py` if editing anything within the base class that needs to be tested.
+ 2. Run `black .` within the base directory for black formatting as it's required for tests to pass
+ 3. Check necessary dependencies defined within `.travis.yml` for now if you're wanting to test locally

galaxy.yml

@@ -0,0 +1,60 @@
+### REQUIRED
+
+# The namespace of the collection. This can be a company/brand/organization or product namespace under which all
+# content lives. May only contain alphanumeric characters and underscores. Additionally namespaces cannot start with
+# underscores or numbers and cannot contain consecutive underscores
+namespace: fragmentedpacket
+
+# The name of the collection. Has the same character restrictions as 'namespace'
+name: netbox_modules
+
+# The version of the collection. Must be compatible with semantic versioning
+version: 0.0.6
+
+# The path to the Markdown (.md) readme file. This path is relative to the root of the collection
+readme: README.md
+
+# A list of the collection's content authors. Can be just the name or in the format 'Full Name <email> (url)
+# @nicks:irc/im.site#channel'
+authors:
+- Mikhail Yohman <mikhail.yohman@gmail.com>
+
+
+### OPTIONAL but strongly recommended
+
+# A short summary description of the collection
+description: This is a collection of Netbox Ansible modules
+
+# Either a single license or a list of licenses for content inside of a collection. Ansible Galaxy currently only
+# accepts L(SPDX,https://spdx.org/licenses/) licenses. This key is mutually exclusive with 'license_file'
+license:
+- MIT
+
+# The path to the license file for the collection. This path is relative to the root of the collection. This key is
+# mutually exclusive with 'license'
+license_file: ''
+
+# A list of tags you want to associate with the collection for indexing/searching. A tag name has the same character
+# requirements as 'namespace' and 'name'
+tags:
+  - system
+  - ipam
+  - networking
+
+# Collections that this collection requires to be installed for it to be usable. The key of the dict is the
+# collection label 'namespace.name'. The value is a version range
+# L(specifiers,https://python-semanticversion.readthedocs.io/en/latest/#requirement-specification). Multiple version
+# range specifiers can be set and are separated by ','
+dependencies: {}
+
+# The URL of the originating SCM repository
+repository: https://github.com/FragmentedPacket/netbox_modules
+
+# The URL to any online docs
+documentation: 
+
+# The URL to the homepage of the collection/project
+homepage:
+
+# The URL to the collection issue tracker
+issues: https://github.com/FragmentedPacket/netbox_modules/issues

plugins/module_utils/__init__.py

@@ -0,0 +1,75 @@
+# -*- coding: utf-8 -*-
+# Copyright: (c) 2018, Mikhail Yohman (@fragmentedpacket) <mikhail.yohman@gmail.com>
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+from __future__ import absolute_import, division, print_function
+
+__metaclass__ = type
+
+# Import necessary packages
+import traceback
+from ansible.module_utils.basic import missing_required_lib
+
+try:
+    from ansible_collections.fragmentedpacket.netbox_modules.plugins.module_utils.netbox_utils import (
+        NetboxModule,
+        ENDPOINT_NAME_MAPPING,
+    )
+except ImportError:
+    import sys
+
+    sys.path.append(".")
+    from netbox_utils import NetboxModule, ENDPOINT_NAME_MAPPING
+
+
+NB_DEVICES = "devices"
+NB_INTERFACES = "interfaces"
+NB_SITES = "sites"
+
+
+class NetboxDcimModule(NetboxModule):
+    def __init__(self, module, endpoint):
+        super().__init__(module, endpoint)
+
+    def run(self):
+        """
+        This function should have all necessary code for endpoints within the application
+        to create/update/delete the endpoint objects
+        Supported endpoints:
+        - devices
+        - interfaces
+        - sites
+        """
+        # Used to dynamically set key when returning results
+        endpoint_name = ENDPOINT_NAME_MAPPING[self.endpoint]
+
+        self.result = {"changed": False}
+
+        application = self._find_app(self.endpoint)
+        nb_app = getattr(self.nb, application)
+        nb_endpoint = getattr(nb_app, self.endpoint)
+
+        data = self.data
+
+        # Used for msg output
+        name = data.get("name")
+
+        object_query_params = self._build_query_params(endpoint_name, data)
+        try:
+            self.nb_object = nb_endpoint.get(**object_query_params)
+        except ValueError:
+            self._handle_errors(msg="More than one result returned for %s" % (name))
+
+        if self.state == "present":
+            self._ensure_object_exists(nb_endpoint, endpoint_name, name, data)
+
+        elif self.state == "absent":
+            self._ensure_object_absent(endpoint_name, name)
+
+        try:
+            serialized_object = self.nb_object.serialize()
+        except AttributeError:
+            serialized_object = self.nb_object
+
+        self.result.update({endpoint_name: serialized_object})
+
+        self.module.exit_json(**self.result)