fully remove tests from packaging

Dev v1.10.7

MANIFEST.in

@@ -1 +0,0 @@
-graft tests/fixtures

README.md

@@ -69,10 +69,21 @@ Release notes can be found [here](https://blog.kellybrazil.com/category/jc-news/
 For more information on the motivations for this project, please see my [blog post](https://blog.kellybrazil.com/2019/11/26/bringing-the-unix-philosophy-to-the-21st-century/).
 
 ## Installation
+There are several ways to get `jc`. You can install via `pip`, `brew`, DEB or RPM packages, or by downloading the correct binary for your architecture and running it anywhere on your filesystem.
+
+### Pip (macOS, linux, unix, Windows)
 ```
 $ pip3 install --upgrade jc
 ```
 
+### Brew (macOS)
+```
+$ brew install jc
+```
+
+### Packages and Binaries
+Please see https://kellyjonbrazil.github.io/jc-packaging/ for details.
+
 ## Usage
 `jc` accepts piped input from `STDIN` and outputs a JSON representation of the previous command's output to `STDOUT`.
 ``` 
@@ -142,7 +153,7 @@ The JSON output can be compact (default) or pretty formatted with the `-p` optio
 - `-m` monochrome JSON output
 - `-p` pretty format the JSON output
 - `-q` quiet mode. Suppresses warning messages
-- `-r` raw output. Provides a more literal JSON output with all values as text and no additional sematic processing
+- `-r` raw output. Provides a more literal JSON output with all values as strings and no additional sematic processing
 
 ### Setting Custom Colors via Environment Variable
 You can specify custom colors via the `JC_COLORS` environment variable. The `JC_COLORS` environment variable takes four comma separated string values in the following format:

changelog.txt

@@ -1,5 +1,18 @@
 jc changelog
 
+20200508 v1.10.8
+- Add license file to dist for Fedora RPM packaging requirements
+- Remove tests from package to keep from polluting the global site-packages
+
+20200501 v1.10.7
+- Requirements modifications for Fedora RPM packaging requirements
+
+20200420 v1.10.6
+- Remove homebrew shim references from du osx tests
+
+20200414 v1.10.5
+- Minor change of using sys.exit(0) instead of exit()
+
 20200412 v1.10.4
 - Add color customization via JC_COLORS env variable
 

docs/parsers/ifconfig.md

@@ -147,6 +147,17 @@ Examples:
 info(self, /, *args, **kwargs)
 ```
 
+## IfconfigParser
+```python
+IfconfigParser(self, console_output)
+```
+
+## InterfaceNotFound
+```python
+InterfaceNotFound(self, /, *args, **kwargs)
+```
+
+
 ## process
 ```python
 process(proc_data)

jc/cli.py

@@ -18,7 +18,7 @@ import jc.utils
 
 
 class info():
-    version = '1.10.4'
+    version = '1.10.8'
     description = 'jc cli output JSON conversion tool'
     author = 'Kelly Brazil'
     author_email = 'kellyjonbrazil@gmail.com'
@@ -322,7 +322,7 @@ def magic():
     valid_command, run_command = generate_magic_command(sys.argv)
     if valid_command:
         os.system(run_command)
-        exit()
+        sys.exit(0)
     elif run_command is None:
         return
     else:
@@ -358,7 +358,7 @@ def main():
 
     if 'a' in options:
         json_out(about_jc(), pretty=pretty, mono=mono, piped_out=piped_output())
-        exit()
+        sys.exit(0)
 
     if sys.stdin.isatty():
         helptext('missing piped data')

jc/parsers/ifconfig.py

@@ -141,16 +141,17 @@ Examples:
       }
     ]
 """
+import re
+from collections import namedtuple
 import jc.utils
-from ifconfigparser import IfconfigParser
 
 
 class info():
-    version = '1.6'
+    version = '1.7'
     description = 'ifconfig command parser'
     author = 'Kelly Brazil'
     author_email = 'kellyjonbrazil@gmail.com'
-    details = 'Using ifconfig-parser package from https://github.com/KnightWhoSayNi/ifconfig-parser'
+    details = 'Using ifconfig-parser from https://github.com/KnightWhoSayNi/ifconfig-parser'
 
     # compatible options: linux, darwin, cygwin, win32, aix, freebsd
     compatible = ['linux', 'aix', 'freebsd', 'darwin']
@@ -160,6 +161,200 @@ class info():
 __version__ = info.version
 
 
+class IfconfigParser(object):
+    #    Author: threeheadedknight@protonmail.com
+    #    Date created: 30.06.2018 17:03
+    #    Python Version: 3.7
+
+    attributes = ['name', 'type', 'mac_addr', 'ipv4_addr', 'ipv4_bcast', 'ipv4_mask', 'ipv6_addr', 'ipv6_mask',
+                  'ipv6_scope', 'state', 'mtu', 'metric', 'rx_packets', 'rx_errors', 'rx_dropped', 'rx_overruns',
+                  'rx_frame', 'tx_packets', 'tx_errors', 'tx_dropped', 'tx_overruns', 'tx_carrier', 'tx_collisions',
+                  'rx_bytes', 'tx_bytes']
+
+    def __init__(self, console_output):
+        """
+        :param console_output:
+        """
+
+        if isinstance(console_output, list):
+            source_data = " ".join(console_output)
+        else:
+            source_data = console_output.replace("\n", " ")
+        self.interfaces = self.parser(source_data=source_data)
+
+    def list_interfaces(self):
+        """
+        :return:
+        """
+        return sorted(self.interfaces.keys())
+
+    def count_interfaces(self):
+        """
+        :return:
+        """
+        return len(self.interfaces.keys())
+
+    def filter_interfaces(self, **kwargs):
+        """
+        :param kwargs:
+        :return:
+        """
+        for attr in kwargs.keys():
+            if attr not in IfconfigParser.attributes:
+                raise ValueError("Attribute [{}] not supported.".format(attr))
+
+        filtered_interfaces = []
+        for name, details in self.interfaces.items():
+
+            if all(getattr(details, attr) == kwargs[attr] for attr in kwargs.keys()):
+                filtered_interfaces.append(name)
+
+        return sorted(filtered_interfaces)
+
+    def get_interface(self, name):
+        """
+        :param name:
+        :return:
+        """
+        if name in self.list_interfaces():
+            return self.interfaces[name]
+        else:
+            raise InterfaceNotFound("Interface [{}] not found.".format(name))
+
+    def get_interfaces(self):
+        """
+        :return:
+        """
+        return self.interfaces
+
+    def is_available(self, name):
+        """
+        :param name:
+        :return:
+        """
+        return name in self.interfaces
+
+    def parser(self, source_data):
+        """
+        :param source_data:
+        :return:
+        """
+
+        # Linux syntax
+        re_linux_interface = re.compile(
+            r"(?P<name>[a-zA-Z0-9:._-]+)\s+Link encap:(?P<type>\S+\s?\S+)(\s+HWaddr\s+\b"
+            r"(?P<mac_addr>[0-9A-Fa-f:?]+))?",
+            re.I)
+        re_linux_ipv4 = re.compile(
+            r"inet addr:(?P<ipv4_addr>(?:[0-9]{1,3}\.){3}[0-9]{1,3})(\s+Bcast:"
+            r"(?P<ipv4_bcast>(?:[0-9]{1,3}\.){3}[0-9]{1,3}))?\s+Mask:(?P<ipv4_mask>(?:[0-9]{1,3}\.){3}[0-9]{1,3})",
+            re.I)
+        re_linux_ipv6 = re.compile(
+            r"inet6 addr:\s+(?P<ipv6_addr>\S+)/(?P<ipv6_mask>[0-9]+)\s+Scope:(?P<ipv6_scope>Link|Host)",
+            re.I)
+        re_linux_state = re.compile(
+            r"\W+(?P<state>(?:\w+\s)+)(?:\s+)?MTU:(?P<mtu>[0-9]+)\s+Metric:(?P<metric>[0-9]+)", re.I)
+        re_linux_rx = re.compile(
+            r"RX packets:(?P<rx_packets>[0-9]+)\s+errors:(?P<rx_errors>[0-9]+)\s+dropped:"
+            r"(?P<rx_dropped>[0-9]+)\s+overruns:(?P<rx_overruns>[0-9]+)\s+frame:(?P<rx_frame>[0-9]+)",
+            re.I)
+        re_linux_tx = re.compile(
+            r"TX packets:(?P<tx_packets>[0-9]+)\s+errors:(?P<tx_errors>[0-9]+)\s+dropped:"
+            r"(?P<tx_dropped>[0-9]+)\s+overruns:(?P<tx_overruns>[0-9]+)\s+carrier:(?P<tx_carrier>[0-9]+)",
+            re.I)
+        re_linux_bytes = re.compile(r"\W+RX bytes:(?P<rx_bytes>\d+)\s+\(.*\)\s+TX bytes:(?P<tx_bytes>\d+)\s+\(.*\)", re.I)
+        re_linux_tx_stats = re.compile(r"collisions:(?P<tx_collisions>[0-9]+)\s+txqueuelen:[0-9]+", re.I)
+        re_linux = [re_linux_interface, re_linux_ipv4, re_linux_ipv6, re_linux_state, re_linux_rx, re_linux_tx,
+                    re_linux_bytes, re_linux_tx_stats]
+
+        # OpenBSD syntax
+        re_openbsd_interface = re.compile(
+            r"(?P<name>[a-zA-Z0-9:._-]+):\s+flags=(?P<flags>[0-9]+)<(?P<state>\S+)?>\s+mtu\s+(?P<mtu>[0-9]+)",
+            re.I)
+        re_openbsd_ipv4 = re.compile(
+            r"inet (?P<ipv4_addr>(?:[0-9]{1,3}\.){3}[0-9]{1,3})\s+netmask\s+"
+            r"(?P<ipv4_mask>(?:[0-9]{1,3}\.){3}[0-9]{1,3})(\s+broadcast\s+"
+            r"(?P<ipv4_bcast>(?:[0-9]{1,3}\.){3}[0-9]{1,3}))?",
+            re.I)
+        re_openbsd_ipv6 = re.compile(
+            r"inet6\s+(?P<ipv6_addr>\S+)\s+prefixlen\s+(?P<ipv6_mask>[0-9]+)\s+scopeid\s+(?P<ipv6_scope>\w+x\w+)<"
+            r"(?:link|host)>",
+            re.I)
+        re_openbsd_details = re.compile(
+            r"\S+\s+(?:(?P<mac_addr>[0-9A-Fa-f:?]+)\s+)?txqueuelen\s+[0-9]+\s+\((?P<type>\S+\s?\S+)\)", re.I)
+        re_openbsd_rx = re.compile(r"RX packets (?P<rx_packets>[0-9]+)\s+bytes\s+(?P<rx_bytes>\d+)\s+.*", re.I)
+        re_openbsd_rx_stats = re.compile(
+            r"RX errors (?P<rx_errors>[0-9]+)\s+dropped\s+(?P<rx_dropped>[0-9]+)\s+overruns\s+"
+            r"(?P<rx_overruns>[0-9]+)\s+frame\s+(?P<rx_frame>[0-9]+)",
+            re.I)
+        re_openbsd_tx = re.compile(r"TX packets (?P<tx_packets>[0-9]+)\s+bytes\s+(?P<tx_bytes>\d+)\s+.*", re.I)
+        re_openbsd_tx_stats = re.compile(
+            r"TX errors (?P<tx_errors>[0-9]+)\s+dropped\s+(?P<tx_dropped>[0-9]+)\s+overruns\s+"
+            r"(?P<tx_overruns>[0-9]+)\s+carrier\s+(?P<tx_carrier>[0-9]+)\s+collisions\s+(?P<tx_collisions>[0-9]+)",
+            re.I)
+        re_openbsd = [re_openbsd_interface, re_openbsd_ipv4, re_openbsd_ipv6, re_openbsd_details, re_openbsd_rx,
+                      re_openbsd_rx_stats, re_openbsd_tx, re_openbsd_tx_stats]
+
+        # FreeBSD syntax
+        re_freebsd_interface = re.compile(
+            r"(?P<name>[a-zA-Z0-9:._-]+):\s+flags=(?P<flags>[0-9]+)<(?P<state>\S+)>\s+metric\s+"
+            r"(?P<metric>[0-9]+)\s+mtu\s+(?P<mtu>[0-9]+)",
+            re.I)
+        re_freebsd_ipv4 = re.compile(
+            r"inet (?P<ipv4_addr>(?:[0-9]{1,3}\.){3}[0-9]{1,3})\s+netmask\s+(?P<ipv4_mask>0x\S+)(\s+broadcast\s+"
+            r"(?P<ipv4_bcast>(?:[0-9]{1,3}\.){3}[0-9]{1,3}))?",
+            re.I)
+        re_freebsd_ipv6 = re.compile(r"\s?inet6\s(?P<ipv6_addr>.*)(?:\%\w+\d+)\sprefixlen\s(?P<ipv6_mask>\d+)(?:\s\w+)?\sscopeid\s(?P<ipv6_scope>\w+x\w+)", re.I)
+        re_freebsd_details = re.compile(r"ether\s+(?P<mac_addr>[0-9A-Fa-f:?]+)", re.I)
+        re_freebsd = [re_freebsd_interface, re_freebsd_ipv4, re_freebsd_ipv6, re_freebsd_details]
+
+        available_interfaces = dict()
+
+        for pattern in [re_linux_interface, re_openbsd_interface, re_freebsd_interface]:
+            network_interfaces = re.finditer(pattern, source_data)
+            positions = []
+            while True:
+                try:
+                    pos = next(network_interfaces)
+                    positions.append(max(pos.start() - 1, 0))
+                except StopIteration:
+                    break
+            if positions:
+                positions.append(len(source_data))
+                break
+
+        if not positions:
+            return available_interfaces
+
+        for l, r in zip(positions, positions[1:]):
+            chunk = source_data[l:r]
+            _interface = dict()
+            for pattern in re_linux + re_openbsd + re_freebsd:
+                match = re.search(pattern, chunk.replace('\t', '\n'))
+                if match:
+                    details = match.groupdict()
+                    for k, v in details.items():
+                        if isinstance(v, str): details[k] = v.strip()
+                    _interface.update(details)
+            if _interface is not None:
+                available_interfaces[_interface['name']] = self.update_interface_details(_interface)
+
+        return available_interfaces
+
+    @staticmethod
+    def update_interface_details(interface):
+        for attr in IfconfigParser.attributes:
+            if attr not in interface:
+                interface[attr] = None
+        return namedtuple('Interface', interface.keys())(**interface)
+
+
+class InterfaceNotFound(Exception):
+    """
+    """
+    pass
+
+
 def process(proc_data):
     """
     Final processing to conform to the schema.

requirements.txt

@@ -1,4 +1,3 @@
-ifconfig-parser>=0.0.5
 ruamel.yaml>=0.15.0
 xmltodict>=0.12.0
-Pygments>=2.5.2
+Pygments>=2.4.2

setup.cfg

@@ -0,0 +1,2 @@
+[metadata]
+license_file = LICENSE.md

setup.py

@@ -5,23 +5,21 @@ with open('README.md', 'r') as f:
 
 setuptools.setup(
     name='jc',
-    version='1.10.4',
+    version='1.10.8',
     author='Kelly Brazil',
     author_email='kellyjonbrazil@gmail.com',
     description='This tool serializes the output of popular command line tools and filetypes to structured JSON output.',
     install_requires=[
-        'ifconfig-parser>=0.0.5',
         'ruamel.yaml>=0.15.0',
         'xmltodict>=0.12.0',
-        'Pygments>=2.5.2'
+        'Pygments>=2.4.2'
     ],
     license='MIT',
     long_description=long_description,
     long_description_content_type='text/markdown',
     python_requires='>=3.6',
     url='https://github.com/kellyjonbrazil/jc',
-    packages=setuptools.find_packages(),
-    include_package_data=True,
+    packages=setuptools.find_packages(exclude=['*.tests', '*.tests.*', 'tests.*', 'tests']),
     entry_points={
         'console_scripts': [
             'jc=jc.cli:main'

tests/fixtures/osx-10.11.6/du.out

@@ -911,13 +911,6 @@
 112	/usr/local/Homebrew/Library/Homebrew/rubocops/cask
 40	/usr/local/Homebrew/Library/Homebrew/rubocops/extend
 344	/usr/local/Homebrew/Library/Homebrew/rubocops
-288	/usr/local/Homebrew/Library/Homebrew/shims/linux/super
-288	/usr/local/Homebrew/Library/Homebrew/shims/linux
-344	/usr/local/Homebrew/Library/Homebrew/shims/mac/super
-344	/usr/local/Homebrew/Library/Homebrew/shims/mac
-16	/usr/local/Homebrew/Library/Homebrew/shims/scm
-280	/usr/local/Homebrew/Library/Homebrew/shims/super
-928	/usr/local/Homebrew/Library/Homebrew/shims
 24	/usr/local/Homebrew/Library/Homebrew/test/cask/artifact/shared_examples
 144	/usr/local/Homebrew/Library/Homebrew/test/cask/artifact
 24	/usr/local/Homebrew/Library/Homebrew/test/cask/cask_loader

tests/fixtures/osx-10.14.6/du.out

@@ -317,13 +317,6 @@
 32	/usr/local/Homebrew/Library/Homebrew/cli
 56	/usr/local/Homebrew/Library/Homebrew/manpages
 8	/usr/local/Homebrew/Library/Homebrew/version
-64	/usr/local/Homebrew/Library/Homebrew/shims/mac/super
-64	/usr/local/Homebrew/Library/Homebrew/shims/mac
-24	/usr/local/Homebrew/Library/Homebrew/shims/super
-8	/usr/local/Homebrew/Library/Homebrew/shims/linux/super
-8	/usr/local/Homebrew/Library/Homebrew/shims/linux
-8	/usr/local/Homebrew/Library/Homebrew/shims/scm
-104	/usr/local/Homebrew/Library/Homebrew/shims
 8	/usr/local/Homebrew/Library/Homebrew/debrew
 56	/usr/local/Homebrew/Library/Homebrew/os/mac/pkgconfig/10.8
 24	/usr/local/Homebrew/Library/Homebrew/os/mac/pkgconfig/10.6