Merge branch 'release-v5.8.7'

Author: qrkourier

.gitattributes

@@ -1 +1,2 @@
 netfoundry/_version.py export-subst
+src/netfoundry/_version.py export-subst

.github/workflows/main.yml

@@ -30,15 +30,21 @@ jobs:
 
     - name: Install dependencies
       run: |
-        python3 -m pip install --upgrade pip
-        pip3 install build
+        python -m pip install --upgrade pip
+        pip install build
 
     - name: Build Package
-      run: python3 -m build
+      run: python -m build
 
-    - name: Install NetFoundry from build tarball
-      run: |
-        pip3 install ./dist/netfoundry-*.tar.gz
+    - name: Upload Wheel Artifact
+      uses: actions/upload-artifact@v3
+      with:
+        name: netfoundry-wheel-${{ github.run_id }}
+        path: dist/netfoundry-*.whl
+        if-no-files-found: error
+
+    - name: Install Wheel
+      run: pip install dist/netfoundry-*.whl
 
     - name: Read version string
       id: read_version
@@ -65,18 +71,17 @@ jobs:
       run: |
         register-python-argcomplete nfctl
 
-    - name: Run the demo script and NF CLI to smoke test installed version
+    - name: Run the NF CLI demo to  test installed version
       env:
-        NETWORK_NAME: github_smoketest_run${{ github.run_id }}
         NETFOUNDRY_CLIENT_ID: ${{ secrets.NETFOUNDRY_CLIENT_ID }}
         NETFOUNDRY_PASSWORD: ${{ secrets.NETFOUNDRY_PASSWORD }}
         NETFOUNDRY_OAUTH_URL: ${{ secrets.NETFOUNDRY_OAUTH_URL }}
       run: |
         set -x
         nfctl config \
-          general.network=${NETWORK_NAME} \
+          general.network=$(nfctl demo --echo-name --prefix 'gh-${{ github.run_id }}') \
           general.yes=True \
-          general.verbose=yes || true # workaround https://github.com/netfoundry/python-netfoundry/issues/29
+          general.verbose=yes
         nfctl demo \
           --regions us-west-2 us-east-2 \
           --provider AWS
@@ -98,13 +103,6 @@ jobs:
         password: ${{ secrets.TEST_PYPI_API_TOKEN }}
         repository_url: https://test.pypi.org/legacy/
 
-    - name: Temporarily Store the Python Package in GitHub # for convenient reference, troubleshooting, investigation, etc...
-      uses: actions/upload-artifact@v3
-      with:
-        name: netfoundry-pypi-${{ github.run_id }}
-        path: dist/netfoundry-*.tar.gz
-        if-no-files-found: error
-
     - name: Append 'latest' tag if release
       env:
         GITHUB_EVENT_ACTION: ${{ github.event.action }}

MANIFEST.in

@@ -1,5 +1,5 @@
-exclude Dockerfile
+exclude docker/
 exclude .gitignore
-exclude .github/workflows/*include versioneer.py
-include netfoundry/_version.py
+exclude .github/workflows/*
 include versioneer.py
+include netfoundry/_version.py

Dockerfile renamed to docker/Dockerfile

@@ -11,3 +11,6 @@
     exit(1)
 
 __version__ = _version.get_versions()['version']
+
+from . import _version
+__version__ = _version.get_versions()['version']

Dockerfile.demo renamed to docker/Dockerfile.demo

@@ -6,7 +6,7 @@
 # that just contains the computed version number.
 
 # This file is released into the public domain. Generated by
-# versioneer-0.21 (https://github.com/python-versioneer/python-versioneer)
+# versioneer-0.22 (https://github.com/python-versioneer/python-versioneer)
 
 """Git implementation of _version.py."""
 
@@ -16,6 +16,7 @@
 import subprocess
 import sys
 from typing import Callable, Dict
+import functools
 
 
 def get_keywords():
@@ -73,14 +74,22 @@ def run_command(commands, args, cwd=None, verbose=False, hide_stderr=False,
     """Call the given command(s)."""
     assert isinstance(commands, list)
     process = None
+
+    popen_kwargs = {}
+    if sys.platform == "win32":
+        # This hides the console window if pythonw.exe is used
+        startupinfo = subprocess.STARTUPINFO()
+        startupinfo.dwFlags |= subprocess.STARTF_USESHOWWINDOW
+        popen_kwargs["startupinfo"] = startupinfo
+
     for command in commands:
         try:
             dispcmd = str([command] + args)
             # remember shell=False, so use git.cmd on windows, not just git
             process = subprocess.Popen([command] + args, cwd=cwd, env=env,
                                        stdout=subprocess.PIPE,
                                        stderr=(subprocess.PIPE if hide_stderr
-                                               else None))
+                                               else None), **popen_kwargs)
             break
         except OSError:
             e = sys.exc_info()[1]
@@ -228,10 +237,15 @@ def git_pieces_from_vcs(tag_prefix, root, verbose, runner=run_command):
     version string, meaning we're inside a checked out source tree.
     """
     GITS = ["git"]
-    TAG_PREFIX_REGEX = "*"
     if sys.platform == "win32":
         GITS = ["git.cmd", "git.exe"]
-        TAG_PREFIX_REGEX = r"\*"
+
+    # GIT_DIR can interfere with correct operation of Versioneer.
+    # It may be intended to be passed to the Versioneer-versioned project,
+    # but that should not change where we get our version from.
+    env = os.environ.copy()
+    env.pop("GIT_DIR", None)
+    runner = functools.partial(runner, env=env)
 
     _, rc = runner(GITS, ["rev-parse", "--git-dir"], cwd=root,
                    hide_stderr=True)
@@ -240,12 +254,12 @@ def git_pieces_from_vcs(tag_prefix, root, verbose, runner=run_command):
             print("Directory %s not under git control" % root)
         raise NotThisMethod("'git rev-parse --git-dir' returned error")
 
+    MATCH_ARGS = ["--match", "%s*" % tag_prefix] if tag_prefix else []
+
     # if there is a tag matching tag_prefix, this yields TAG-NUM-gHEX[-dirty]
     # if there isn't one, this yields HEX[-dirty] (no NUM)
     describe_out, rc = runner(GITS, ["describe", "--tags", "--dirty",
-                                     "--always", "--long",
-                                     "--match",
-                                     "%s%s" % (tag_prefix, TAG_PREFIX_REGEX)],
+                                     "--always", "--long", *MATCH_ARGS],
                               cwd=root)
     # --long was added in git-1.5.5
     if describe_out is None:

netfoundry/__init__.py

@@ -102,7 +102,7 @@ def main(cli):
 
 
 @cli.argument('-e', '--eval', help="source or eval output to configure shell environment with a login token", arg_only=True, action="store_true", default=False)
-@cli.subcommand('login to a management API')
+@cli.subcommand('login to NetFoundry with a user token or API account credentials')
 def login(cli):
     """Login to an API and cache the expiring token."""
     # if logging in to a NF org (default)
@@ -174,15 +174,35 @@ def login(cli):
                 else:
                     cli.echo(json_dumps(summary_object, indent=4))
         else:             # if eval
+            nonf = """
+# helper function logs out from NetFoundry
+function nonf(){
+    unset   NETFOUNDRY_API_ACCOUNT NETFOUNDRY_API_TOKEN \
+            NETFOUNDRY_CLIENT_ID NETFOUNDRY_PASSWORD NETFOUNDRY_OAUTH_URL \
+            NETFOUNDRY_ORGANIZATION NETFOUNDRY_NETWORK NETFOUNDRY_NETWORK_GROUP \
+            MOPENV MOPURL
+}
+"""
+            noaws = """
+# helper function logs out from AWS
+function noaws(){
+    unset   AWS_SECURITY_TOKEN AWS_SESSION_TOKEN \
+            AWS_ACCESS_KEY AWS_ACCESS_KEY_ID AWS_SECRET_ACCESS_KEY \
+            AWS_REGION AWS_DEFAULT_REGION AWS_SHARED_CREDENTIALS_FILE
+}
+"""
             token_env = f"""
-# $ eval "$({cli.prog_name} --credentials=credentials.json login --eval)"
+# $ eval "$({cli.prog_name} --credentials={organization.credentials} login --eval)"
 export NETFOUNDRY_API_TOKEN="{organization.token}"
 export NETFOUNDRY_API_ACCOUNT="{organization.credentials if hasattr(organization, 'credentials') else ''}"
 export NETFOUNDRY_ORGANIZATION="{organization.id}"
-{'export NETFOUNDRY_NETWORK="'+network.id+'"' if network else ''}
-{'export NETFOUNDRY_NETWORK_GROUP="'+network_group.id+'"' if network_group else ''}
-{'export MOPENV="'+organization.environment+'"' if organization.environment else ''}
+{'export NETFOUNDRY_NETWORK="'+network.id+'"' if network else '# NETFOUNDRY_NETWORK'}
+{'export NETFOUNDRY_NETWORK_GROUP="'+network_group.id+'"' if network_group else '# NETFOUNDRY_NETWORK_GROUP'}
+export MOPENV="{organization.environment}"
+export MOPURL="{organization.audience}"
 eval "$(register-python-argcomplete {cli.prog_name})"
+{nonf}
+{noaws}
 """
             if cli.config.general.color:
                 highlighted = highlight(token_env, bash_lexer, Terminal256Formatter(style=cli.config.general.style))
@@ -191,7 +211,7 @@ def login(cli):
                 cli.echo(token_env)
 
 
-@cli.subcommand('logout current profile from an organization')
+@cli.subcommand('logout your identity for the current current profile')
 def logout(cli):
     """Logout by deleting the cached token."""
     spinner = get_spinner("working")
@@ -346,7 +366,7 @@ def edit(cli):
 @cli.argument('-k', '--keys', arg_only=True, action=StoreListKeys, help="list of keys as a,b,c to print only selected keys (columns)")
 @cli.argument('-a', '--as', dest='accept', arg_only=True, choices=['create'], help="request the as=create alternative form of the resource")
 @cli.argument('resource_type', arg_only=True, help='type of resource', metavar="RESOURCE_TYPE", choices=[choice for group in [[singular(type), RESOURCES[type].abbreviation] for type in RESOURCES.keys()] for choice in group])
-@cli.subcommand('get a single resource by query')
+@cli.subcommand('get a single resource by type and query')
 def get(cli, echo: bool = True, embed='all', spinner: object = None):
     """
     Get a single resource as YAML or JSON.
@@ -358,7 +378,7 @@ def get(cli, echo: bool = True, embed='all', spinner: object = None):
         cli.args.resource_type = singular(RESOURCE_ABBREV[cli.args.resource_type].name)
     if not cli.config.general.verbose and cli.args.output in ["yaml", "json"]:    # don't change level if output=text
         cli.log.setLevel(logging.WARN)                                            # don't emit INFO messages to stdout because they will break deserialization
-    if cli.args.accept and not MUTABLE_NET_RESOURCES.get(cli.args.resource_type):
+    if cli.args.accept and not MUTABLE_NET_RESOURCES.get(plural(cli.args.resource_type)):
         logging.warning("ignoring --as=create becuase it is applicable only to mutable resources in the network domain")
         cli.args['accept'] = None
     match = {}
@@ -530,7 +550,7 @@ def get(cli, echo: bool = True, embed='all', spinner: object = None):
 @cli.argument('-m', '--my-roles', arg_only=True, action='store_true', help="filter roles by caller identity")
 @cli.argument('-a', '--as', dest='accept', arg_only=True, choices=['create'], help="request the as=create alternative form of the resources")
 @cli.argument('resource_type', arg_only=True, help='type of resource', metavar="RESOURCE_TYPE", choices=[choice for group in [[type, RESOURCES[type].abbreviation] for type in RESOURCES.keys()] for choice in group])
-@cli.subcommand(description='find resources as lists')
+@cli.subcommand(description='find a collection of resources by type and query')
 def list(cli, spinner: object = None):
     """Find resources as lists."""
     if not spinner:
@@ -662,7 +682,7 @@ def list(cli, spinner: object = None):
 
 @cli.argument('query', arg_only=True, action=StoreDictKeyPair, nargs='?', help="query params as k=v,k=v comma-separated pairs")
 @cli.argument('resource_type', arg_only=True, help='type of resource', choices=[choice for group in [[singular(type), RESOURCES[type].abbreviation] for type in RESOURCES.keys()] for choice in group])
-@cli.subcommand('delete a resource in the network domain')
+@cli.subcommand('delete a single resource by type and query')
 def delete(cli):
     """Delete a resource in the network domain."""
     spinner = get_spinner("working")
@@ -747,7 +767,8 @@ def delete(cli):
 
 
 @cli.argument("-p", "--prefix", default=f"{cli.prog_name}-demo", help="choose a network name prefix to identify all of your demos")
-@cli.argument("-j", "--jwt",  action="store_boolean", default=True, help="save the one-time enroll token for each demo identity in the current directory")
+@cli.argument("-j", "--jwt", action="store_boolean", default=True, help="save the one-time enroll token for each demo identity in the current directory")
+@cli.argument("-e", "--echo-name", arg_only=True, action="store_true", default=False, help="only echo a friendly network name then exit")
 @cli.argument("-s", "--size", default="small", help=argparse.SUPPRESS)   # troubleshoot scale-up instance size factor
 @cli.argument("-v", "--product-version", default="default", help="network product version: 'default', 'latest', or any active semver")
 @cli.argument("--provider", default="AWS", help="cloud provider for hosted edge routers", choices=DC_PROVIDERS)
@@ -761,11 +782,14 @@ def demo(cli):
     if cli.config.general.network:
         network_name = cli.config.general.network
     else:
-        resources_dir = path.join(path.dirname(__file__), 'resources')
-        friendly_words_filename = path.join(resources_dir, "friendly-words/generated/words.json")
+        friendly_words_dir = path.join(path.dirname(__file__), 'friendly-words')
+        friendly_words_filename = path.join(friendly_words_dir, "generated/words.json")
         with open(friendly_words_filename, 'r') as friendly_words_path:
             friendly_words = json_load(friendly_words_path)
         network_name = f"{cli.config.demo.prefix}-{choice(friendly_words['predicates'])}-{choice(friendly_words['objects'])}"
+        if cli.args.echo_name:
+            cli.echo(network_name)
+            sysexit(0)
     demo_confirmed = False
     if cli.config.general.yes:
         demo_confirmed = True

netfoundry/_version.py

@@ -1,4 +1,8 @@
 # pyproject.toml
 [build-system]
-requires = ["setuptools>=45", "wheel", "versioneer>=0.21"]
+requires = [
+    "setuptools >= 61",
+    "wheel >= 0.37",
+    "versioneer >= 0.22"
+]
 

netfoundry/ctl.py

@@ -1,7 +1,54 @@
+[metadata]
+name = netfoundry
+project_urls =
+    Documentation = https://developer.netfoundry.io/guides/python/
+    Source = https://github.com/netfoundry/python-netfoundry/
+    Tracker = https://github.com/netfoundry/python-netfoundry/issues
+
+description = Interface to the NetFoundry network-as-code orchestration platform
+long_description = file: README.md
+long_description_content_type = text/markdown
+license = MIT
+author = Kenneth Bingham
+author_email = [email protected]
+maintainer = NetFoundry
+maintainer_email = [email protected]
+classifiers =
+    Programming Language :: Python :: 3
+    Operating System :: OS Independent
+
+[options]
+python_requires = >=3.7
+zip_safe = False
+include_package_data = True
+packages = find:
+install_requires =
+    inflect >= 5.3
+    milc >= 1.6.6
+    packaging >= 20.9
+    platformdirs >= 2.4
+    pygments >= 2.11
+    pyjwt >= 2.3
+    pyyaml >= 5.4
+    requests >= 2.27
+    tabulate >= 0.8
+setup_requires =
+    setuptools_scm
+
+[bdist_wheel]
+universal = 1
+
+[options.package_data]
+    netfoundry = friendly-words/generated/words.json
+
+[options.entry_points]
+console_scripts =
+    nfdemo = netfoundry.demo:main
+    nfctl = netfoundry.ctl:cli
+
 [versioneer]
 VCS = git
 style = pep440-pre
 versionfile_source = netfoundry/_version.py
 versionfile_build = netfoundry/_version.py
 tag_prefix = v
-#parentdir_prefix = myproject-

netfoundry/resources/friendly-words/.gitignore renamed to netfoundry/friendly-words/.gitignore

@@ -2,42 +2,8 @@
 import versioneer
 import setuptools
 
-with open("README.md", "r") as fh:
-    long_description = fh.read()
-
-setuptools.setup(
-    name='netfoundry',
-    py_modules=['netfoundry'],
-    version=versioneer.get_version(),
-    cmdclass=versioneer.get_cmdclass(),
-    url='https://developer.netfoundry.io/guides/python/',
-    description='Interface to the NetFoundry network-as-code orchestration Platform',
-    long_description=long_description,
-    long_description_content_type="text/markdown",
-    license='MIT',
-    author='Kenneth Bingham',
-    author_email='[email protected]',
-    packages=setuptools.find_packages(),
-    python_requires='>=3.7',
-    classifiers=[
-        "Programming Language :: Python :: 3",
-        "Operating System :: OS Independent",
-    ],
-    install_requires=[
-        'requests >= 2.27',
-        'pyjwt >= 2.3',
-        'inflect >= 5.3',
-        'milc >= 1.6.6',
-        'pyyaml >= 5.4',
-        'platformdirs >= 2.4',
-        'tabulate >= 0.8',
-        'packaging >= 20.9',
-        'pygments >= 2.11'
-    ],
-    entry_points={
-        'console_scripts': [
-            'nfdemo = netfoundry.demo:main',
-            'nfctl = netfoundry.ctl:cli',
-        ]
-    }
-)
+if __name__ == "__main__":
+    setuptools.setup(
+        version=versioneer.get_version(),
+        cmdclass=versioneer.get_cmdclass(),
+    )