updates (#11)

* add gh actions

* pyupgrade, isort, black

* flake8

.github/workflows/tests.yml

@@ -0,0 +1,84 @@
+name: tests
+
+on: [push, pull_request]
+
+jobs:
+
+  linting:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v2
+      - uses: actions/cache@v2
+        with:
+          path: ~/.cache/pip
+          key: ${{ runner.os }}-pip
+          restore-keys: ${{ runner.os }}-pip
+      - name: Install Poetry
+        uses: snok/[email protected]
+        with:
+          virtualenvs-create: true
+          virtualenvs-in-project: true
+          # virtualenvs-path: ~/.venv
+      - name: Load cached venv
+        id: cached-poetry-dependencies
+        uses: actions/cache@v2
+        with:
+          path: .venv
+          key: venv-${{ runner.os }}-${{ hashFiles('**/poetry.lock') }}
+      # install dependencies if cache does not exist
+      - name: Check cache and install dependencies
+        run: poetry install
+        if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true'
+      - name: Run linters
+        run: |
+          source .venv/bin/activate
+          flake8 .
+          black . --check
+          isort .
+
+  test:
+    needs: linting
+    strategy:
+      fail-fast: true
+      matrix:
+        os: [ "ubuntu-latest", "macos-latest" ]
+        python-version: [ "3.6", "3.7", "3.8", "3.9" ]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v2
+      - name: Set up python ${{ matrix.python-version }}
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install Poetry
+        uses: snok/[email protected]
+        with:
+          virtualenvs-create: true
+          virtualenvs-in-project: true
+      # This approach appears to be cachign the repo source as well (e.g,
+      # the library code that tests are supposed to test)
+      #
+      # FIXME
+      #
+      #- name: Load cached venv
+      #  id: cached-poetry-dependencies
+      #  uses: actions/cache@v2
+      #  with:
+      #    path: .venv
+      #    key: venv-${{ runner.os }}-${{ hashFiles('**/poetry.lock') }}
+      # install dependencies if cache does not exist
+      - name: Check cache and install dependencies
+        run: poetry install
+      - name: Run tests
+        run: |
+          source .venv/bin/activate
+          poetry run pytest tests/ --cov="confu" --cov-report=xml --cov-report=term-missing
+          poetry run coverage report
+      # upload coverage stats
+      - name: Upload coverage
+        uses: codecov/codecov-action@v1
+        with:
+          file: ./coverage.xml
+          fail_ci_if_error: true

src/netom/__init__.py

@@ -1,16 +1,15 @@
-
 import ipaddress
 import os
-from pkg_resources import get_distribution
 
 import confu
-from confu import schema
 import tmpl
+from confu import schema
+from pkg_resources import get_distribution
 
-# TODO move out of this namespace
-from .models import BgpNeighbor
 from .exception import NetomValidationError
 
+# TODO move out of this namespace
+from .models import BgpNeighbor
 
 __version__ = get_distribution("netom").version
 
@@ -30,7 +29,7 @@ def ip_version(value):
     return ipaddress.ip_address(value).version
 
 
-class Render(object):
+class Render:
     """
     Renders data to defined type.
     """
@@ -47,17 +46,19 @@ def __init__(self, model_version, model_type):
         self.type = model_type
 
         # FIXME use pkg resources
-        search_path = os.path.join(os.getcwd(), "src/netom/templates/", self.version, self.type) #, "bgp")
+        search_path = os.path.join(
+            os.getcwd(), "src/netom/templates/", self.version, self.type
+        )  # , "bgp")
         self.engine = tmpl.get_engine("jinja2")(search_path=search_path)
         self.engine.engine.filters["make_variable_name"] = make_variable_name
         self.engine.engine.filters["ip_version"] = ip_version
         # self.engine.search_path = os.path.dirname(search_path)
 
     def _render(self, filename, data, fobj):
-        #engine.engine.undefined = IgnoreUndefined
+        # engine.engine.undefined = IgnoreUndefined
         output = self.engine._render(src=filename, env=data)
         fobj.write(output)
-        #ctx.tmpl.update(engine=engine)
+        # ctx.tmpl.update(engine=engine)
 
     def bgp_neighbors(self, data, fobj, validate=True):
         """
@@ -68,7 +69,7 @@ def bgp_neighbors(self, data, fobj, validate=True):
         # collate by group
         for each in data["neighbors"]:
             if validate:
-                validate_data(BgpNeighbor(), each)
+                validate(BgpNeighbor(), each)
             groups.setdefault(each["peer_group"], []).append(each)
 
         groups = dict(peer_groups=groups)

src/netom/__main__.py

@@ -1,6 +1,5 @@
 import sys
 
-
 if __name__ == "__main__":
     from .cli import main
 

src/netom/cli.py

@@ -1,4 +1,3 @@
-
 import argparse
 import io
 import sys
@@ -7,13 +6,17 @@
 
 import netom
 
+
 def main(argv=None):
     if argv is None:
         argv = sys.argv[1:]
 
     parser = argparse.ArgumentParser(description="netom")
-    parser.add_argument("--version", action="version",
-                        version="{}s version {}".format("%(prog)", netom.__version__))
+    parser.add_argument(
+        "--version",
+        action="version",
+        version="{}s version {}".format("%(prog)", netom.__version__),
+    )
     # parser.add_argument("--output-format", help="output format (yaml, json, text)")
 
     parser.add_argument("command")
@@ -31,6 +34,9 @@ def main(argv=None):
     model_version = argd["model_version"]
     model_type = argd["model_type"]
 
+    if command != "render":
+        raise Exception("only render is supported")
+
     render = netom.Render(model_version, model_type)
     data = munge.load_datafile(argd["data_file"])
 

src/netom/exception.py

@@ -1,6 +1,6 @@
-
 class NetomException(Exception):
     """Base exception used by this module."""
 
+
 class NetomValidationError(NetomException):
     """A validation error occurred."""

src/netom/models.py

@@ -1,22 +1,31 @@
-
-import confu
 from confu import schema
 
+
 class BgpNeighbor(schema.Schema):
     """
     Defines the BGP Neighbor model.
     """
 
     name = schema.Str("name", help="name of the session")
-    description = schema.Str("description", help="description of the session", default=None)
+    description = schema.Str(
+        "description", help="description of the session", default=None
+    )
     enabled = schema.Bool("enabled", help="enabled", default=True)
     neighbor_address = schema.IpAddress("neighbor_address", help="neighbor IP address")
     peer_as = schema.Int("peer_as", help="neighbor AS number")
     peer_group = schema.Str("peer_group", help="peer group")
-    peer_type = schema.Str("peer_type", help="peer type (internal or external)", default="external")
-    max_prefixes = schema.Int("max_prefixes", help="maximum number of prefixes to accept")
+    peer_type = schema.Str(
+        "peer_type", help="peer type (internal or external)", default="external"
+    )
+    max_prefixes = schema.Int(
+        "max_prefixes", help="maximum number of prefixes to accept"
+    )
     import_policy = schema.Str("import_policy", help="Import policy to apply")
     export_policy = schema.Str("export_policy", help="Export policy to apply")
-    auth_password = schema.Str("auth_password", help="MD5 session password", default=None)
-    local_address = schema.IpAddress("local_address", help="local IP address", default=None)
+    auth_password = schema.Str(
+        "auth_password", help="MD5 session password", default=None
+    )
+    local_address = schema.IpAddress(
+        "local_address", help="local IP address", default=None
+    )
     local_as = schema.Int("peer_as", help="neighbor AS number", default=0)

tests/conftest.py

@@ -1,7 +1,6 @@
-
 import os
 
-import pytest 
+import pytest
 
 
 @pytest.fixture

tests/test_bgp_neighbor.py

@@ -1,15 +1,12 @@
-
-from confu.schema import validate
 import pytest
 
 import netom
 from netom import exception
 from netom.models import BgpNeighbor
 
-
 INVALID0 = dict(
     neighbor_address="not an ip",
-    )
+)
 
 
 VALID0 = dict(
@@ -22,7 +19,7 @@
     enabled=True,
     import_policy="peer-in",
     export_policy="peer-out",
-    )
+)
 
 
 # FIXME

tests/test_init.py

@@ -1,7 +1,5 @@
-
-import pytest
-
 import netom
 
+
 def test_init():
-    pass
+    assert netom.Render("test", "12")