mirror of
https://github.com/openziti/zrok.git
synced 2024-11-07 00:34:17 +01:00
Python SDK Update (#523)
* added first iteration decorator for zrok and example flask server * update requirements. Add context managing for share and access. Updated pastebin example to better cleanup * setup and sample tweaks * small linting updates and example changes * A few small fixes * fix long description * Update the ignore file. Considering moving location of this. * Added flake8 linting for builds * use python 3.10 * move setup python to its own block * added back in the py name * update changelogs and add readme --------- Signed-off-by: Cam Otts <otts.cameron@gmail.com> Co-authored-by: Kenneth Bingham <kenneth.bingham@netfoundry.io>
This commit is contained in:
parent
16e2cff4c9
commit
3e6ab2b39b
13
.github/workflows/ci-build.yml
vendored
13
.github/workflows/ci-build.yml
vendored
@ -51,6 +51,19 @@ jobs:
|
||||
shell: bash
|
||||
run: go test -v ./...
|
||||
|
||||
- name: setup python
|
||||
uses: actions/setup-python@v3
|
||||
with:
|
||||
python-version: '3.10'
|
||||
|
||||
- name: python deps
|
||||
shell: bash
|
||||
run: python -m pip install -U pip flake8
|
||||
|
||||
- name: python lint
|
||||
shell: bash
|
||||
run: flake8 sdk/python/sdk/zrok
|
||||
|
||||
- name: solve GOBIN
|
||||
id: solve_go_bin
|
||||
shell: bash
|
||||
|
@ -6,6 +6,14 @@ CHANGE: Improved OpenZiti resource cleanup resilience. Previous resource cleanup
|
||||
|
||||
CHANGE: Instead of setting the `ListenOptions.MaxConnections` property to `64`, use the default value of `3`. This property actually controls the number of terminators created on the underlying OpenZiti network. This property is actually getting renamed to `ListenOptions.MaxTerminators` in an upcoming release of `github.com/openziti/sdk-golang` (https://github.com/openziti/zrok/issues/535)
|
||||
|
||||
CHANGE: Versioning for the Python SDK has been updated to use versioneer for management.
|
||||
|
||||
CHANGE: Python SDK package name has been renamed to `zrok`, dropping the `-sdk` postfix. [pypi](https://pypi.org/project/zrok).
|
||||
|
||||
FEATURE: Python SDK now has a decorator for integrating with various server side frameworks. See the `http-server` example.
|
||||
|
||||
FEATURE: Python SDK share and access handling now supports context management.
|
||||
|
||||
## v0.4.22
|
||||
|
||||
FIX: The goreleaser action is not updated to work with the latest golang build. Modifed `go.mod` to comply with what goreleaser expects
|
||||
|
59
sdk/golang/examples/http-server/README.md
Normal file
59
sdk/golang/examples/http-server/README.md
Normal file
@ -0,0 +1,59 @@
|
||||
# "http-server" SDK Example
|
||||
|
||||
This `http-server` example is a minimal `zrok` application that surfaces a basic http server over a public zrok share.
|
||||
|
||||
## Implementation
|
||||
|
||||
```go
|
||||
root, err := environment.LoadRoot()
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
```
|
||||
|
||||
The `root` is a structure that contains all of the user's environment detail and allows the SDK application to access the `zrok` service instance and the underlying OpenZiti network.
|
||||
|
||||
```go
|
||||
shr, err := sdk.CreateShare(root, &sdk.ShareRequest{
|
||||
BackendMode: sdk.TcpTunnelBackendMode,
|
||||
ShareMode: sdk.PublicShareMode,
|
||||
Frontends: []string{"public"},
|
||||
Target: "http-server",
|
||||
})
|
||||
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
defer func() {
|
||||
if err := sdk.DeleteShare(root, shr); err != nil {
|
||||
panic(err)
|
||||
}
|
||||
}()
|
||||
...
|
||||
fmt.Println("Access server at the following endpoints: ", strings.Join(shr.FrontendEndpoints, "\n"))
|
||||
|
||||
```
|
||||
|
||||
The `sdk.CreateShare` call uses the loaded `environment` root along with the details of the share request (`sdk.ShareRequest`) to create the share that will be used to access the `http-server`.
|
||||
|
||||
We are using the `sdk.TcpTunnelBackendMode` to handle tcp traffic. This time we are using `sdk.PublicShareMode` to take advantage of a public share that is running. With that we set which frontends to listen on, so we use whatever is configured, `public` here.
|
||||
|
||||
Further down we emit where to access the service.
|
||||
|
||||
Then we create a listener and use that to server our http server:
|
||||
|
||||
```go
|
||||
conn, err := sdk.NewListener(shr.Token, root)
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
defer conn.Close()
|
||||
|
||||
...
|
||||
|
||||
http.HandleFunc("/", helloZrok)
|
||||
|
||||
if err := http.Serve(conn, nil); err != nil {
|
||||
panic(err)
|
||||
}
|
||||
```
|
51
sdk/golang/examples/http-server/cmd/http-server/main.go
Normal file
51
sdk/golang/examples/http-server/cmd/http-server/main.go
Normal file
@ -0,0 +1,51 @@
|
||||
package main
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"github.com/openziti/zrok/environment"
|
||||
"github.com/openziti/zrok/sdk/golang/sdk"
|
||||
"io"
|
||||
"net/http"
|
||||
"strings"
|
||||
)
|
||||
|
||||
func helloZrok(w http.ResponseWriter, r *http.Request) {
|
||||
io.WriteString(w, "Hello zrok!\n")
|
||||
}
|
||||
|
||||
func main() {
|
||||
root, err := environment.LoadRoot()
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
|
||||
shr, err := sdk.CreateShare(root, &sdk.ShareRequest{
|
||||
BackendMode: sdk.TcpTunnelBackendMode,
|
||||
ShareMode: sdk.PublicShareMode,
|
||||
Frontends: []string{"public"},
|
||||
Target: "http-server",
|
||||
})
|
||||
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
defer func() {
|
||||
if err := sdk.DeleteShare(root, shr); err != nil {
|
||||
panic(err)
|
||||
}
|
||||
}()
|
||||
|
||||
conn, err := sdk.NewListener(shr.Token, root)
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
defer conn.Close()
|
||||
|
||||
fmt.Println("Access server at the following endpoints: ", strings.Join(shr.FrontendEndpoints, "\n"))
|
||||
|
||||
http.HandleFunc("/", helloZrok)
|
||||
|
||||
if err := http.Serve(conn, nil); err != nil {
|
||||
panic(err)
|
||||
}
|
||||
}
|
54
sdk/python/examples/http-server/README.md
Normal file
54
sdk/python/examples/http-server/README.md
Normal file
@ -0,0 +1,54 @@
|
||||
# "http-server" SDK Example
|
||||
|
||||
This `http-server` example is a minimal `zrok` application that surfaces a basic http server over a public zrok share.
|
||||
|
||||
## Implementation
|
||||
|
||||
```go
|
||||
root = zrok.environment.root.Load()
|
||||
```
|
||||
|
||||
The `root` is a structure that contains all of the user's environment detail and allows the SDK application to access the `zrok` service instance and the underlying OpenZiti network.
|
||||
|
||||
```python
|
||||
try:
|
||||
shr = zrok.share.CreateShare(root=root, request=ShareRequest(
|
||||
BackendMode=zrok.model.TCP_TUNNEL_BACKEND_MODE,
|
||||
ShareMode=zrok.model.PUBLIC_SHARE_MODE,
|
||||
Frontends=['public'],
|
||||
Target="http-server"
|
||||
))
|
||||
shrToken = shr.Token
|
||||
print("Access server at the following endpoints: ", "\n".join(shr.FrontendEndpoints))
|
||||
|
||||
def removeShare():
|
||||
zrok.share.DeleteShare(root=root, shr=shr)
|
||||
print("Deleted share")
|
||||
atexit.register(removeShare)
|
||||
except Exception as e:
|
||||
print("unable to create share", e)
|
||||
sys.exit(1)
|
||||
|
||||
```
|
||||
|
||||
The `sdk.CreateShare` call uses the loaded `environment` root along with the details of the share request (`sdk.ShareRequest`) to create the share that will be used to access the `http-server`.
|
||||
|
||||
We are using the `sdk.TcpTunnelBackendMode` to handle tcp traffic. This time we are using `sdk.PublicShareMode` to take advantage of a public share that is running. With that we set which frontends to listen on, so we use whatever is configured, `public` here.
|
||||
|
||||
|
||||
Next we populate our cfg options for our decorator
|
||||
|
||||
```python
|
||||
zrok_opts['cfg'] = zrok.decor.Opts(root=root, shrToken=shrToken, bindPort=bindPort)
|
||||
```
|
||||
|
||||
Next we run the server which ends up calling the following:
|
||||
|
||||
```python
|
||||
@zrok.decor.zrok(opts=zrok_opts)
|
||||
def runApp():
|
||||
from waitress import serve
|
||||
# the port is only used to integrate Zrok with frameworks that expect a "hostname:port" combo
|
||||
serve(app, port=bindPort)
|
||||
```
|
||||
|
3
sdk/python/examples/http-server/requirements.txt
Normal file
3
sdk/python/examples/http-server/requirements.txt
Normal file
@ -0,0 +1,3 @@
|
||||
Flask==3.0.0
|
||||
waitress==2.1.2
|
||||
zrok
|
48
sdk/python/examples/http-server/server.py
Executable file
48
sdk/python/examples/http-server/server.py
Executable file
@ -0,0 +1,48 @@
|
||||
#!python3
|
||||
from flask import Flask
|
||||
import sys
|
||||
import zrok
|
||||
from zrok.model import ShareRequest
|
||||
import atexit
|
||||
|
||||
app = Flask(__name__)
|
||||
zrok_opts = {}
|
||||
bindPort = 18081
|
||||
|
||||
|
||||
@zrok.decor.zrok(opts=zrok_opts)
|
||||
def runApp():
|
||||
from waitress import serve
|
||||
# the port is only used to integrate Zrok with frameworks that expect a "hostname:port" combo
|
||||
serve(app, port=bindPort)
|
||||
|
||||
|
||||
@app.route('/')
|
||||
def hello_world():
|
||||
print("received a request to /")
|
||||
return "Look! It's zrok!"
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
root = zrok.environment.root.Load()
|
||||
try:
|
||||
shr = zrok.share.CreateShare(root=root, request=ShareRequest(
|
||||
BackendMode=zrok.model.TCP_TUNNEL_BACKEND_MODE,
|
||||
ShareMode=zrok.model.PUBLIC_SHARE_MODE,
|
||||
Frontends=['public'],
|
||||
Target="http-server"
|
||||
))
|
||||
shrToken = shr.Token
|
||||
print("Access server at the following endpoints: ", "\n".join(shr.FrontendEndpoints))
|
||||
|
||||
def removeShare():
|
||||
zrok.share.DeleteShare(root=root, shr=shr)
|
||||
print("Deleted share")
|
||||
atexit.register(removeShare)
|
||||
except Exception as e:
|
||||
print("unable to create share", e)
|
||||
sys.exit(1)
|
||||
|
||||
zrok_opts['cfg'] = zrok.decor.Opts(root=root, shrToken=shrToken, bindPort=bindPort)
|
||||
|
||||
runApp()
|
@ -1,5 +1,6 @@
|
||||
#!python3
|
||||
import argparse
|
||||
import atexit
|
||||
import sys
|
||||
import os
|
||||
import zrok
|
||||
@ -29,20 +30,23 @@ class copyto:
|
||||
print("unable to create share", e)
|
||||
sys.exit(1)
|
||||
|
||||
def removeShare():
|
||||
try:
|
||||
zrok.share.DeleteShare(root, shr)
|
||||
except Exception as e:
|
||||
print("unable to delete share", e)
|
||||
sys.exit(1)
|
||||
atexit.register(removeShare)
|
||||
|
||||
data = self.loadData()
|
||||
print("access your pastebin using 'pastebin.py pastefrom " + shr.Token + "'")
|
||||
|
||||
try:
|
||||
with zrok.listener.Listener(shr.Token, root) as server:
|
||||
while not exit_signal.is_set():
|
||||
conn, peer = server.accept()
|
||||
with conn:
|
||||
conn.sendall(data.encode('utf-8'))
|
||||
with zrok.listener.Listener(shr.Token, root) as server:
|
||||
while not exit_signal.is_set():
|
||||
conn, peer = server.accept()
|
||||
with conn:
|
||||
conn.sendall(data.encode('utf-8'))
|
||||
|
||||
except KeyboardInterrupt:
|
||||
pass
|
||||
|
||||
zrok.share.DeleteShare(root, shr)
|
||||
print("Server stopped.")
|
||||
|
||||
|
||||
@ -62,15 +66,18 @@ def pastefrom(options):
|
||||
except Exception as e:
|
||||
print("unable to create access", e)
|
||||
sys.exit(1)
|
||||
|
||||
def removeAccess():
|
||||
try:
|
||||
zrok.access.DeleteAccess(root, acc)
|
||||
except Exception as e:
|
||||
print("unable to delete access", e)
|
||||
sys.exit(1)
|
||||
atexit.register(removeAccess)
|
||||
|
||||
client = zrok.dialer.Dialer(options.shrToken, root)
|
||||
data = client.recv(1024)
|
||||
print(data.decode('utf-8'))
|
||||
try:
|
||||
zrok.access.DeleteAccess(root, acc)
|
||||
except Exception as e:
|
||||
print("unable to delete access", e)
|
||||
sys.exit(1)
|
||||
|
||||
if __name__ == "__main__":
|
||||
parser = argparse.ArgumentParser()
|
@ -1,3 +1,3 @@
|
||||
openziti==0.8.1
|
||||
requests==2.31.0
|
||||
zrok-sdk
|
||||
zrok
|
1
sdk/python/sdk/zrok/.gitattributes
vendored
Normal file
1
sdk/python/sdk/zrok/.gitattributes
vendored
Normal file
@ -0,0 +1 @@
|
||||
zrok/_version.py export-subst
|
@ -28,4 +28,5 @@ tox.ini
|
||||
test-requirements.txt
|
||||
test/
|
||||
docs/
|
||||
README.md
|
||||
README.md
|
||||
setup.py
|
@ -1 +1 @@
|
||||
from . import environment
|
||||
from . import environment # noqa
|
||||
|
@ -3,3 +3,4 @@ six >= 1.10
|
||||
python_dateutil >= 2.5.3
|
||||
setuptools >= 21.0.0
|
||||
urllib3 >= 1.15.1
|
||||
openziti >= 0.8.1
|
33
sdk/python/sdk/zrok/setup.cfg
Normal file
33
sdk/python/sdk/zrok/setup.cfg
Normal file
@ -0,0 +1,33 @@
|
||||
[metadata]
|
||||
name = openziti
|
||||
author = OpenZiti Developers
|
||||
author_email = developers@openziti.org
|
||||
description = Ziti Python SDK
|
||||
long_description = file: README.md
|
||||
long_description_content_type = text/markdown
|
||||
url = https://github.com/openziti/zrok
|
||||
license = Apache 2.0
|
||||
project_urls =
|
||||
Source = https://github.com/openziti/zrok
|
||||
Tracker = https://github.com/openziti/zrok/issues
|
||||
Discussion = https://openziti.discourse.group/
|
||||
|
||||
[options]
|
||||
package_dir =
|
||||
= .
|
||||
packages = find:
|
||||
|
||||
[options.packages.find]
|
||||
where = .
|
||||
|
||||
[flake8]
|
||||
exclude = zrok_api, build
|
||||
max-line-length = 120
|
||||
|
||||
[versioneer]
|
||||
VCS = git
|
||||
style = pep440-pre
|
||||
versionfile_source = zrok/_version.py
|
||||
versionfile_build = zrok/_version.py
|
||||
tag_prefix = v
|
||||
parentdir_prefix = zrok-
|
@ -1,18 +1,9 @@
|
||||
# coding: utf-8
|
||||
|
||||
"""
|
||||
zrok
|
||||
|
||||
zrok client access # noqa: E501
|
||||
|
||||
OpenAPI spec version: 0.3.0
|
||||
|
||||
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
||||
"""
|
||||
|
||||
from setuptools import setup, find_packages # noqa: H301
|
||||
import os
|
||||
import versioneer
|
||||
|
||||
NAME = "zrok_sdk"
|
||||
# optionally upload to TestPyPi with alternative name in testing repo
|
||||
NAME = os.getenv('ZROK_PY_NAME', "zrok")
|
||||
VERSION = "1.0.0"
|
||||
# To install the library, run the following
|
||||
#
|
||||
@ -21,19 +12,21 @@ VERSION = "1.0.0"
|
||||
# prerequisite: setuptools
|
||||
# http://pypi.python.org/pypi/setuptools
|
||||
|
||||
REQUIRES = ["urllib3 >= 1.15", "six >= 1.10", "certifi", "python-dateutil"]
|
||||
REQUIRES = ["urllib3 >= 1.15", "six >= 1.10", "certifi", "python-dateutil", "openziti >= 0.8.1"]
|
||||
|
||||
setup(
|
||||
name=NAME,
|
||||
version=VERSION,
|
||||
cmdclass=versioneer.get_cmdclass(dict()),
|
||||
version=versioneer.get_version(),
|
||||
description="zrok",
|
||||
author_email="",
|
||||
url="",
|
||||
keywords=["Swagger", "zrok"],
|
||||
install_requires=REQUIRES,
|
||||
python_requires='>3.10.0',
|
||||
packages=find_packages(),
|
||||
include_package_data=True,
|
||||
long_description="""\
|
||||
zrok client access # noqa: E501
|
||||
Geo-scale, next-generation peer-to-peer sharing platform built on top of OpenZiti.
|
||||
"""
|
||||
)
|
||||
|
2277
sdk/python/sdk/zrok/versioneer.py
Normal file
2277
sdk/python/sdk/zrok/versioneer.py
Normal file
File diff suppressed because it is too large
Load Diff
@ -1,2 +1,4 @@
|
||||
from . import environment
|
||||
from . import access, model, share, overview
|
||||
from . import environment # noqa
|
||||
from . import access, decor, model, share, overview # noqa
|
||||
from . import _version
|
||||
__version__ = _version.get_versions()['version']
|
||||
|
683
sdk/python/sdk/zrok/zrok/_version.py
Normal file
683
sdk/python/sdk/zrok/zrok/_version.py
Normal file
@ -0,0 +1,683 @@
|
||||
|
||||
# This file helps to compute a version number in source trees obtained from
|
||||
# git-archive tarball (such as those provided by githubs download-from-tag
|
||||
# feature). Distribution tarballs (built by setup.py sdist) and build
|
||||
# directories (produced by setup.py build) will contain a much shorter file
|
||||
# that just contains the computed version number.
|
||||
|
||||
# This file is released into the public domain.
|
||||
# Generated by versioneer-0.29
|
||||
# https://github.com/python-versioneer/python-versioneer
|
||||
|
||||
"""Git implementation of _version.py."""
|
||||
|
||||
import errno
|
||||
import os
|
||||
import re
|
||||
import subprocess
|
||||
import sys
|
||||
from typing import Any, Callable, Dict, List, Optional, Tuple
|
||||
import functools
|
||||
|
||||
|
||||
def get_keywords() -> Dict[str, str]:
|
||||
"""Get the keywords needed to look up the version information."""
|
||||
# these strings will be replaced by git during git-archive.
|
||||
# setup.py/versioneer.py will grep for the variable names, so they must
|
||||
# each be defined on a line of their own. _version.py will just call
|
||||
# get_keywords().
|
||||
git_refnames = "$Format:%d$"
|
||||
git_full = "$Format:%H$"
|
||||
git_date = "$Format:%ci$"
|
||||
keywords = {"refnames": git_refnames, "full": git_full, "date": git_date}
|
||||
return keywords
|
||||
|
||||
|
||||
class VersioneerConfig:
|
||||
"""Container for Versioneer configuration parameters."""
|
||||
|
||||
VCS: str
|
||||
style: str
|
||||
tag_prefix: str
|
||||
parentdir_prefix: str
|
||||
versionfile_source: str
|
||||
verbose: bool
|
||||
|
||||
|
||||
def get_config() -> VersioneerConfig:
|
||||
"""Create, populate and return the VersioneerConfig() object."""
|
||||
# these strings are filled in when 'setup.py versioneer' creates
|
||||
# _version.py
|
||||
cfg = VersioneerConfig()
|
||||
cfg.VCS = "git"
|
||||
cfg.style = "pep440-pre"
|
||||
cfg.tag_prefix = "v"
|
||||
cfg.parentdir_prefix = "zrok-"
|
||||
cfg.versionfile_source = "zrok/_version.py"
|
||||
cfg.verbose = False
|
||||
return cfg
|
||||
|
||||
|
||||
class NotThisMethod(Exception):
|
||||
"""Exception raised if a method is not valid for the current scenario."""
|
||||
|
||||
|
||||
LONG_VERSION_PY: Dict[str, str] = {}
|
||||
HANDLERS: Dict[str, Dict[str, Callable]] = {}
|
||||
|
||||
|
||||
def register_vcs_handler(vcs: str, method: str) -> Callable: # decorator
|
||||
"""Create decorator to mark a method as the handler of a VCS."""
|
||||
def decorate(f: Callable) -> Callable:
|
||||
"""Store f in HANDLERS[vcs][method]."""
|
||||
if vcs not in HANDLERS:
|
||||
HANDLERS[vcs] = {}
|
||||
HANDLERS[vcs][method] = f
|
||||
return f
|
||||
return decorate
|
||||
|
||||
|
||||
def run_command(
|
||||
commands: List[str],
|
||||
args: List[str],
|
||||
cwd: Optional[str] = None,
|
||||
verbose: bool = False,
|
||||
hide_stderr: bool = False,
|
||||
env: Optional[Dict[str, str]] = None,
|
||||
) -> Tuple[Optional[str], Optional[int]]:
|
||||
"""Call the given command(s)."""
|
||||
assert isinstance(commands, list)
|
||||
process = None
|
||||
|
||||
popen_kwargs: Dict[str, Any] = {}
|
||||
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), **popen_kwargs)
|
||||
break
|
||||
except OSError as e:
|
||||
if e.errno == errno.ENOENT:
|
||||
continue
|
||||
if verbose:
|
||||
print("unable to run %s" % dispcmd)
|
||||
print(e)
|
||||
return None, None
|
||||
else:
|
||||
if verbose:
|
||||
print("unable to find command, tried %s" % (commands,))
|
||||
return None, None
|
||||
stdout = process.communicate()[0].strip().decode()
|
||||
if process.returncode != 0:
|
||||
if verbose:
|
||||
print("unable to run %s (error)" % dispcmd)
|
||||
print("stdout was %s" % stdout)
|
||||
return None, process.returncode
|
||||
return stdout, process.returncode
|
||||
|
||||
|
||||
def versions_from_parentdir(
|
||||
parentdir_prefix: str,
|
||||
root: str,
|
||||
verbose: bool,
|
||||
) -> Dict[str, Any]:
|
||||
"""Try to determine the version from the parent directory name.
|
||||
|
||||
Source tarballs conventionally unpack into a directory that includes both
|
||||
the project name and a version string. We will also support searching up
|
||||
two directory levels for an appropriately named parent directory
|
||||
"""
|
||||
rootdirs = []
|
||||
|
||||
for _ in range(3):
|
||||
dirname = os.path.basename(root)
|
||||
if dirname.startswith(parentdir_prefix):
|
||||
return {"version": dirname[len(parentdir_prefix):],
|
||||
"full-revisionid": None,
|
||||
"dirty": False, "error": None, "date": None}
|
||||
rootdirs.append(root)
|
||||
root = os.path.dirname(root) # up a level
|
||||
|
||||
if verbose:
|
||||
print("Tried directories %s but none started with prefix %s" %
|
||||
(str(rootdirs), parentdir_prefix))
|
||||
raise NotThisMethod("rootdir doesn't start with parentdir_prefix")
|
||||
|
||||
|
||||
@register_vcs_handler("git", "get_keywords")
|
||||
def git_get_keywords(versionfile_abs: str) -> Dict[str, str]:
|
||||
"""Extract version information from the given file."""
|
||||
# the code embedded in _version.py can just fetch the value of these
|
||||
# keywords. When used from setup.py, we don't want to import _version.py,
|
||||
# so we do it with a regexp instead. This function is not used from
|
||||
# _version.py.
|
||||
keywords: Dict[str, str] = {}
|
||||
try:
|
||||
with open(versionfile_abs, "r") as fobj:
|
||||
for line in fobj:
|
||||
if line.strip().startswith("git_refnames ="):
|
||||
mo = re.search(r'=\s*"(.*)"', line)
|
||||
if mo:
|
||||
keywords["refnames"] = mo.group(1)
|
||||
if line.strip().startswith("git_full ="):
|
||||
mo = re.search(r'=\s*"(.*)"', line)
|
||||
if mo:
|
||||
keywords["full"] = mo.group(1)
|
||||
if line.strip().startswith("git_date ="):
|
||||
mo = re.search(r'=\s*"(.*)"', line)
|
||||
if mo:
|
||||
keywords["date"] = mo.group(1)
|
||||
except OSError:
|
||||
pass
|
||||
return keywords
|
||||
|
||||
|
||||
@register_vcs_handler("git", "keywords")
|
||||
def git_versions_from_keywords(
|
||||
keywords: Dict[str, str],
|
||||
tag_prefix: str,
|
||||
verbose: bool,
|
||||
) -> Dict[str, Any]:
|
||||
"""Get version information from git keywords."""
|
||||
if "refnames" not in keywords:
|
||||
raise NotThisMethod("Short version file found")
|
||||
date = keywords.get("date")
|
||||
if date is not None:
|
||||
# Use only the last line. Previous lines may contain GPG signature
|
||||
# information.
|
||||
date = date.splitlines()[-1]
|
||||
|
||||
# git-2.2.0 added "%cI", which expands to an ISO-8601 -compliant
|
||||
# datestamp. However we prefer "%ci" (which expands to an "ISO-8601
|
||||
# -like" string, which we must then edit to make compliant), because
|
||||
# it's been around since git-1.5.3, and it's too difficult to
|
||||
# discover which version we're using, or to work around using an
|
||||
# older one.
|
||||
date = date.strip().replace(" ", "T", 1).replace(" ", "", 1)
|
||||
refnames = keywords["refnames"].strip()
|
||||
if refnames.startswith("$Format"):
|
||||
if verbose:
|
||||
print("keywords are unexpanded, not using")
|
||||
raise NotThisMethod("unexpanded keywords, not a git-archive tarball")
|
||||
refs = {r.strip() for r in refnames.strip("()").split(",")}
|
||||
# starting in git-1.8.3, tags are listed as "tag: foo-1.0" instead of
|
||||
# just "foo-1.0". If we see a "tag: " prefix, prefer those.
|
||||
TAG = "tag: "
|
||||
tags = {r[len(TAG):] for r in refs if r.startswith(TAG)}
|
||||
if not tags:
|
||||
# Either we're using git < 1.8.3, or there really are no tags. We use
|
||||
# a heuristic: assume all version tags have a digit. The old git %d
|
||||
# expansion behaves like git log --decorate=short and strips out the
|
||||
# refs/heads/ and refs/tags/ prefixes that would let us distinguish
|
||||
# between branches and tags. By ignoring refnames without digits, we
|
||||
# filter out many common branch names like "release" and
|
||||
# "stabilization", as well as "HEAD" and "master".
|
||||
tags = {r for r in refs if re.search(r'\d', r)}
|
||||
if verbose:
|
||||
print("discarding '%s', no digits" % ",".join(refs - tags))
|
||||
if verbose:
|
||||
print("likely tags: %s" % ",".join(sorted(tags)))
|
||||
for ref in sorted(tags):
|
||||
# sorting will prefer e.g. "2.0" over "2.0rc1"
|
||||
if ref.startswith(tag_prefix):
|
||||
r = ref[len(tag_prefix):]
|
||||
# Filter out refs that exactly match prefix or that don't start
|
||||
# with a number once the prefix is stripped (mostly a concern
|
||||
# when prefix is '')
|
||||
if not re.match(r'\d', r):
|
||||
continue
|
||||
if verbose:
|
||||
print("picking %s" % r)
|
||||
return {"version": r,
|
||||
"full-revisionid": keywords["full"].strip(),
|
||||
"dirty": False, "error": None,
|
||||
"date": date}
|
||||
# no suitable tags, so version is "0+unknown", but full hex is still there
|
||||
if verbose:
|
||||
print("no suitable tags, using unknown + full revision id")
|
||||
return {"version": "0+unknown",
|
||||
"full-revisionid": keywords["full"].strip(),
|
||||
"dirty": False, "error": "no suitable tags", "date": None}
|
||||
|
||||
|
||||
@register_vcs_handler("git", "pieces_from_vcs")
|
||||
def git_pieces_from_vcs(
|
||||
tag_prefix: str,
|
||||
root: str,
|
||||
verbose: bool,
|
||||
runner: Callable = run_command
|
||||
) -> Dict[str, Any]:
|
||||
"""Get version from 'git describe' in the root of the source tree.
|
||||
|
||||
This only gets called if the git-archive 'subst' keywords were *not*
|
||||
expanded, and _version.py hasn't already been rewritten with a short
|
||||
version string, meaning we're inside a checked out source tree.
|
||||
"""
|
||||
GITS = ["git"]
|
||||
if sys.platform == "win32":
|
||||
GITS = ["git.cmd", "git.exe"]
|
||||
|
||||
# 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=not verbose)
|
||||
if rc != 0:
|
||||
if verbose:
|
||||
print("Directory %s not under git control" % root)
|
||||
raise NotThisMethod("'git rev-parse --git-dir' returned error")
|
||||
|
||||
# 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", f"{tag_prefix}[[:digit:]]*"
|
||||
], cwd=root)
|
||||
# --long was added in git-1.5.5
|
||||
if describe_out is None:
|
||||
raise NotThisMethod("'git describe' failed")
|
||||
describe_out = describe_out.strip()
|
||||
full_out, rc = runner(GITS, ["rev-parse", "HEAD"], cwd=root)
|
||||
if full_out is None:
|
||||
raise NotThisMethod("'git rev-parse' failed")
|
||||
full_out = full_out.strip()
|
||||
|
||||
pieces: Dict[str, Any] = {}
|
||||
pieces["long"] = full_out
|
||||
pieces["short"] = full_out[:7] # maybe improved later
|
||||
pieces["error"] = None
|
||||
|
||||
branch_name, rc = runner(GITS, ["rev-parse", "--abbrev-ref", "HEAD"],
|
||||
cwd=root)
|
||||
# --abbrev-ref was added in git-1.6.3
|
||||
if rc != 0 or branch_name is None:
|
||||
raise NotThisMethod("'git rev-parse --abbrev-ref' returned error")
|
||||
branch_name = branch_name.strip()
|
||||
|
||||
if branch_name == "HEAD":
|
||||
# If we aren't exactly on a branch, pick a branch which represents
|
||||
# the current commit. If all else fails, we are on a branchless
|
||||
# commit.
|
||||
branches, rc = runner(GITS, ["branch", "--contains"], cwd=root)
|
||||
# --contains was added in git-1.5.4
|
||||
if rc != 0 or branches is None:
|
||||
raise NotThisMethod("'git branch --contains' returned error")
|
||||
branches = branches.split("\n")
|
||||
|
||||
# Remove the first line if we're running detached
|
||||
if "(" in branches[0]:
|
||||
branches.pop(0)
|
||||
|
||||
# Strip off the leading "* " from the list of branches.
|
||||
branches = [branch[2:] for branch in branches]
|
||||
if "master" in branches:
|
||||
branch_name = "master"
|
||||
elif not branches:
|
||||
branch_name = None
|
||||
else:
|
||||
# Pick the first branch that is returned. Good or bad.
|
||||
branch_name = branches[0]
|
||||
|
||||
pieces["branch"] = branch_name
|
||||
|
||||
# parse describe_out. It will be like TAG-NUM-gHEX[-dirty] or HEX[-dirty]
|
||||
# TAG might have hyphens.
|
||||
git_describe = describe_out
|
||||
|
||||
# look for -dirty suffix
|
||||
dirty = git_describe.endswith("-dirty")
|
||||
pieces["dirty"] = dirty
|
||||
if dirty:
|
||||
git_describe = git_describe[:git_describe.rindex("-dirty")]
|
||||
|
||||
# now we have TAG-NUM-gHEX or HEX
|
||||
|
||||
if "-" in git_describe:
|
||||
# TAG-NUM-gHEX
|
||||
mo = re.search(r'^(.+)-(\d+)-g([0-9a-f]+)$', git_describe)
|
||||
if not mo:
|
||||
# unparsable. Maybe git-describe is misbehaving?
|
||||
pieces["error"] = ("unable to parse git-describe output: '%s'"
|
||||
% describe_out)
|
||||
return pieces
|
||||
|
||||
# tag
|
||||
full_tag = mo.group(1)
|
||||
if not full_tag.startswith(tag_prefix):
|
||||
if verbose:
|
||||
fmt = "tag '%s' doesn't start with prefix '%s'"
|
||||
print(fmt % (full_tag, tag_prefix))
|
||||
pieces["error"] = ("tag '%s' doesn't start with prefix '%s'"
|
||||
% (full_tag, tag_prefix))
|
||||
return pieces
|
||||
pieces["closest-tag"] = full_tag[len(tag_prefix):]
|
||||
|
||||
# distance: number of commits since tag
|
||||
pieces["distance"] = int(mo.group(2))
|
||||
|
||||
# commit: short hex revision ID
|
||||
pieces["short"] = mo.group(3)
|
||||
|
||||
else:
|
||||
# HEX: no tags
|
||||
pieces["closest-tag"] = None
|
||||
out, rc = runner(GITS, ["rev-list", "HEAD", "--left-right"], cwd=root)
|
||||
pieces["distance"] = len(out.split()) # total number of commits
|
||||
|
||||
# commit date: see ISO-8601 comment in git_versions_from_keywords()
|
||||
date = runner(GITS, ["show", "-s", "--format=%ci", "HEAD"], cwd=root)[0].strip()
|
||||
# Use only the last line. Previous lines may contain GPG signature
|
||||
# information.
|
||||
date = date.splitlines()[-1]
|
||||
pieces["date"] = date.strip().replace(" ", "T", 1).replace(" ", "", 1)
|
||||
|
||||
return pieces
|
||||
|
||||
|
||||
def plus_or_dot(pieces: Dict[str, Any]) -> str:
|
||||
"""Return a + if we don't already have one, else return a ."""
|
||||
if "+" in pieces.get("closest-tag", ""):
|
||||
return "."
|
||||
return "+"
|
||||
|
||||
|
||||
def render_pep440(pieces: Dict[str, Any]) -> str:
|
||||
"""Build up version string, with post-release "local version identifier".
|
||||
|
||||
Our goal: TAG[+DISTANCE.gHEX[.dirty]] . Note that if you
|
||||
get a tagged build and then dirty it, you'll get TAG+0.gHEX.dirty
|
||||
|
||||
Exceptions:
|
||||
1: no tags. git_describe was just HEX. 0+untagged.DISTANCE.gHEX[.dirty]
|
||||
"""
|
||||
if pieces["closest-tag"]:
|
||||
rendered = pieces["closest-tag"]
|
||||
if pieces["distance"] or pieces["dirty"]:
|
||||
rendered += plus_or_dot(pieces)
|
||||
rendered += "%d.g%s" % (pieces["distance"], pieces["short"])
|
||||
if pieces["dirty"]:
|
||||
rendered += ".dirty"
|
||||
else:
|
||||
# exception #1
|
||||
rendered = "0+untagged.%d.g%s" % (pieces["distance"],
|
||||
pieces["short"])
|
||||
if pieces["dirty"]:
|
||||
rendered += ".dirty"
|
||||
return rendered
|
||||
|
||||
|
||||
def render_pep440_branch(pieces: Dict[str, Any]) -> str:
|
||||
"""TAG[[.dev0]+DISTANCE.gHEX[.dirty]] .
|
||||
|
||||
The ".dev0" means not master branch. Note that .dev0 sorts backwards
|
||||
(a feature branch will appear "older" than the master branch).
|
||||
|
||||
Exceptions:
|
||||
1: no tags. 0[.dev0]+untagged.DISTANCE.gHEX[.dirty]
|
||||
"""
|
||||
if pieces["closest-tag"]:
|
||||
rendered = pieces["closest-tag"]
|
||||
if pieces["distance"] or pieces["dirty"]:
|
||||
if pieces["branch"] != "master":
|
||||
rendered += ".dev0"
|
||||
rendered += plus_or_dot(pieces)
|
||||
rendered += "%d.g%s" % (pieces["distance"], pieces["short"])
|
||||
if pieces["dirty"]:
|
||||
rendered += ".dirty"
|
||||
else:
|
||||
# exception #1
|
||||
rendered = "0"
|
||||
if pieces["branch"] != "master":
|
||||
rendered += ".dev0"
|
||||
rendered += "+untagged.%d.g%s" % (pieces["distance"],
|
||||
pieces["short"])
|
||||
if pieces["dirty"]:
|
||||
rendered += ".dirty"
|
||||
return rendered
|
||||
|
||||
|
||||
def pep440_split_post(ver: str) -> Tuple[str, Optional[int]]:
|
||||
"""Split pep440 version string at the post-release segment.
|
||||
|
||||
Returns the release segments before the post-release and the
|
||||
post-release version number (or -1 if no post-release segment is present).
|
||||
"""
|
||||
vc = str.split(ver, ".post")
|
||||
return vc[0], int(vc[1] or 0) if len(vc) == 2 else None
|
||||
|
||||
|
||||
def render_pep440_pre(pieces: Dict[str, Any]) -> str:
|
||||
"""TAG[.postN.devDISTANCE] -- No -dirty.
|
||||
|
||||
Exceptions:
|
||||
1: no tags. 0.post0.devDISTANCE
|
||||
"""
|
||||
if pieces["closest-tag"]:
|
||||
if pieces["distance"]:
|
||||
# update the post release segment
|
||||
tag_version, post_version = pep440_split_post(pieces["closest-tag"])
|
||||
rendered = tag_version
|
||||
if post_version is not None:
|
||||
rendered += ".post%d.dev%d" % (post_version + 1, pieces["distance"])
|
||||
else:
|
||||
rendered += ".post0.dev%d" % (pieces["distance"])
|
||||
else:
|
||||
# no commits, use the tag as the version
|
||||
rendered = pieces["closest-tag"]
|
||||
else:
|
||||
# exception #1
|
||||
rendered = "0.post0.dev%d" % pieces["distance"]
|
||||
return rendered
|
||||
|
||||
|
||||
def render_pep440_post(pieces: Dict[str, Any]) -> str:
|
||||
"""TAG[.postDISTANCE[.dev0]+gHEX] .
|
||||
|
||||
The ".dev0" means dirty. Note that .dev0 sorts backwards
|
||||
(a dirty tree will appear "older" than the corresponding clean one),
|
||||
but you shouldn't be releasing software with -dirty anyways.
|
||||
|
||||
Exceptions:
|
||||
1: no tags. 0.postDISTANCE[.dev0]
|
||||
"""
|
||||
if pieces["closest-tag"]:
|
||||
rendered = pieces["closest-tag"]
|
||||
if pieces["distance"] or pieces["dirty"]:
|
||||
rendered += ".post%d" % pieces["distance"]
|
||||
if pieces["dirty"]:
|
||||
rendered += ".dev0"
|
||||
rendered += plus_or_dot(pieces)
|
||||
rendered += "g%s" % pieces["short"]
|
||||
else:
|
||||
# exception #1
|
||||
rendered = "0.post%d" % pieces["distance"]
|
||||
if pieces["dirty"]:
|
||||
rendered += ".dev0"
|
||||
rendered += "+g%s" % pieces["short"]
|
||||
return rendered
|
||||
|
||||
|
||||
def render_pep440_post_branch(pieces: Dict[str, Any]) -> str:
|
||||
"""TAG[.postDISTANCE[.dev0]+gHEX[.dirty]] .
|
||||
|
||||
The ".dev0" means not master branch.
|
||||
|
||||
Exceptions:
|
||||
1: no tags. 0.postDISTANCE[.dev0]+gHEX[.dirty]
|
||||
"""
|
||||
if pieces["closest-tag"]:
|
||||
rendered = pieces["closest-tag"]
|
||||
if pieces["distance"] or pieces["dirty"]:
|
||||
rendered += ".post%d" % pieces["distance"]
|
||||
if pieces["branch"] != "master":
|
||||
rendered += ".dev0"
|
||||
rendered += plus_or_dot(pieces)
|
||||
rendered += "g%s" % pieces["short"]
|
||||
if pieces["dirty"]:
|
||||
rendered += ".dirty"
|
||||
else:
|
||||
# exception #1
|
||||
rendered = "0.post%d" % pieces["distance"]
|
||||
if pieces["branch"] != "master":
|
||||
rendered += ".dev0"
|
||||
rendered += "+g%s" % pieces["short"]
|
||||
if pieces["dirty"]:
|
||||
rendered += ".dirty"
|
||||
return rendered
|
||||
|
||||
|
||||
def render_pep440_old(pieces: Dict[str, Any]) -> str:
|
||||
"""TAG[.postDISTANCE[.dev0]] .
|
||||
|
||||
The ".dev0" means dirty.
|
||||
|
||||
Exceptions:
|
||||
1: no tags. 0.postDISTANCE[.dev0]
|
||||
"""
|
||||
if pieces["closest-tag"]:
|
||||
rendered = pieces["closest-tag"]
|
||||
if pieces["distance"] or pieces["dirty"]:
|
||||
rendered += ".post%d" % pieces["distance"]
|
||||
if pieces["dirty"]:
|
||||
rendered += ".dev0"
|
||||
else:
|
||||
# exception #1
|
||||
rendered = "0.post%d" % pieces["distance"]
|
||||
if pieces["dirty"]:
|
||||
rendered += ".dev0"
|
||||
return rendered
|
||||
|
||||
|
||||
def render_git_describe(pieces: Dict[str, Any]) -> str:
|
||||
"""TAG[-DISTANCE-gHEX][-dirty].
|
||||
|
||||
Like 'git describe --tags --dirty --always'.
|
||||
|
||||
Exceptions:
|
||||
1: no tags. HEX[-dirty] (note: no 'g' prefix)
|
||||
"""
|
||||
if pieces["closest-tag"]:
|
||||
rendered = pieces["closest-tag"]
|
||||
if pieces["distance"]:
|
||||
rendered += "-%d-g%s" % (pieces["distance"], pieces["short"])
|
||||
else:
|
||||
# exception #1
|
||||
rendered = pieces["short"]
|
||||
if pieces["dirty"]:
|
||||
rendered += "-dirty"
|
||||
return rendered
|
||||
|
||||
|
||||
def render_git_describe_long(pieces: Dict[str, Any]) -> str:
|
||||
"""TAG-DISTANCE-gHEX[-dirty].
|
||||
|
||||
Like 'git describe --tags --dirty --always -long'.
|
||||
The distance/hash is unconditional.
|
||||
|
||||
Exceptions:
|
||||
1: no tags. HEX[-dirty] (note: no 'g' prefix)
|
||||
"""
|
||||
if pieces["closest-tag"]:
|
||||
rendered = pieces["closest-tag"]
|
||||
rendered += "-%d-g%s" % (pieces["distance"], pieces["short"])
|
||||
else:
|
||||
# exception #1
|
||||
rendered = pieces["short"]
|
||||
if pieces["dirty"]:
|
||||
rendered += "-dirty"
|
||||
return rendered
|
||||
|
||||
|
||||
def render(pieces: Dict[str, Any], style: str) -> Dict[str, Any]:
|
||||
"""Render the given version pieces into the requested style."""
|
||||
if pieces["error"]:
|
||||
return {"version": "unknown",
|
||||
"full-revisionid": pieces.get("long"),
|
||||
"dirty": None,
|
||||
"error": pieces["error"],
|
||||
"date": None}
|
||||
|
||||
if not style or style == "default":
|
||||
style = "pep440" # the default
|
||||
|
||||
if style == "pep440":
|
||||
rendered = render_pep440(pieces)
|
||||
elif style == "pep440-branch":
|
||||
rendered = render_pep440_branch(pieces)
|
||||
elif style == "pep440-pre":
|
||||
rendered = render_pep440_pre(pieces)
|
||||
elif style == "pep440-post":
|
||||
rendered = render_pep440_post(pieces)
|
||||
elif style == "pep440-post-branch":
|
||||
rendered = render_pep440_post_branch(pieces)
|
||||
elif style == "pep440-old":
|
||||
rendered = render_pep440_old(pieces)
|
||||
elif style == "git-describe":
|
||||
rendered = render_git_describe(pieces)
|
||||
elif style == "git-describe-long":
|
||||
rendered = render_git_describe_long(pieces)
|
||||
else:
|
||||
raise ValueError("unknown style '%s'" % style)
|
||||
|
||||
return {"version": rendered, "full-revisionid": pieces["long"],
|
||||
"dirty": pieces["dirty"], "error": None,
|
||||
"date": pieces.get("date")}
|
||||
|
||||
|
||||
def get_versions() -> Dict[str, Any]:
|
||||
"""Get version information or return default if unable to do so."""
|
||||
# I am in _version.py, which lives at ROOT/VERSIONFILE_SOURCE. If we have
|
||||
# __file__, we can work backwards from there to the root. Some
|
||||
# py2exe/bbfreeze/non-CPython implementations don't do __file__, in which
|
||||
# case we can only use expanded keywords.
|
||||
|
||||
cfg = get_config()
|
||||
verbose = cfg.verbose
|
||||
|
||||
try:
|
||||
return git_versions_from_keywords(get_keywords(), cfg.tag_prefix,
|
||||
verbose)
|
||||
except NotThisMethod:
|
||||
pass
|
||||
|
||||
try:
|
||||
root = os.path.realpath(__file__)
|
||||
# versionfile_source is the relative path from the top of the source
|
||||
# tree (where the .git directory might live) to this file. Invert
|
||||
# this to find the root from __file__.
|
||||
for _ in cfg.versionfile_source.split('/'):
|
||||
root = os.path.dirname(root)
|
||||
except NameError:
|
||||
return {"version": "0+unknown", "full-revisionid": None,
|
||||
"dirty": None,
|
||||
"error": "unable to find root of source tree",
|
||||
"date": None}
|
||||
|
||||
try:
|
||||
pieces = git_pieces_from_vcs(cfg.tag_prefix, root, verbose)
|
||||
return render(pieces, cfg.style)
|
||||
except NotThisMethod:
|
||||
pass
|
||||
|
||||
try:
|
||||
if cfg.parentdir_prefix:
|
||||
return versions_from_parentdir(cfg.parentdir_prefix, root, verbose)
|
||||
except NotThisMethod:
|
||||
pass
|
||||
|
||||
return {"version": "0+unknown", "full-revisionid": None,
|
||||
"dirty": None,
|
||||
"error": "unable to compute version", "date": None}
|
@ -3,6 +3,24 @@ from zrok_api.models import AccessRequest, UnaccessRequest
|
||||
from zrok_api.api import ShareApi
|
||||
from zrok import model
|
||||
|
||||
|
||||
class Access():
|
||||
root: Root
|
||||
request: model.AccessRequest
|
||||
access: model.Access
|
||||
|
||||
def __init__(self, root: Root, request: model.AccessRequest):
|
||||
self.root = root
|
||||
self.request = request
|
||||
|
||||
def __enter__(self) -> model.Access:
|
||||
self.access = CreateAccess(root=self.root, request=self.request)
|
||||
return self.access
|
||||
|
||||
def __exit__(self, exception_type, exception_value, exception_traceback):
|
||||
DeleteAccess(root=self.root, acc=self.access)
|
||||
|
||||
|
||||
def CreateAccess(root: Root, request: model.AccessRequest) -> model.Access:
|
||||
if not root.IsEnabled():
|
||||
raise Exception("environment is not enabled; enable with 'zrok enable' first!")
|
||||
@ -19,20 +37,21 @@ def CreateAccess(root: Root, request: model.AccessRequest) -> model.Access:
|
||||
except Exception as e:
|
||||
raise Exception("unable to create access", e)
|
||||
return model.Access(Token=res.frontend_token,
|
||||
ShareToken=request.ShareToken,
|
||||
BackendMode=res.backend_mode)
|
||||
ShareToken=request.ShareToken,
|
||||
BackendMode=res.backend_mode)
|
||||
|
||||
|
||||
def DeleteAccess(root: Root, acc: model.Access):
|
||||
req = UnaccessRequest(frontend_token=acc.Token,
|
||||
shr_token=acc.ShareToken,
|
||||
env_zid=root.env.ZitiIdentity)
|
||||
|
||||
|
||||
try:
|
||||
zrok = root.Client()
|
||||
except Exception as e:
|
||||
raise Exception("error getting zrok client", e)
|
||||
|
||||
|
||||
try:
|
||||
ShareApi(zrok).unaccess(body=req)
|
||||
except Exception as e:
|
||||
raise Exception("error deleting access", e)
|
||||
raise Exception("error deleting access", e)
|
||||
|
33
sdk/python/sdk/zrok/zrok/decor.py
Normal file
33
sdk/python/sdk/zrok/zrok/decor.py
Normal file
@ -0,0 +1,33 @@
|
||||
from dataclasses import dataclass
|
||||
import openziti
|
||||
from zrok.environment.root import Root
|
||||
|
||||
|
||||
@dataclass
|
||||
class Opts:
|
||||
root: Root
|
||||
shrToken: str
|
||||
bindPort: int
|
||||
bindHost: str = ""
|
||||
|
||||
|
||||
class MonkeyPatch(openziti.monkeypatch):
|
||||
def __init__(self, opts: {}, *args, **kwargs):
|
||||
zif = opts['cfg'].root.ZitiIdentityNamed(opts['cfg'].root.EnvironmentIdentityName())
|
||||
cfg = dict(ztx=openziti.load(zif), service=opts['cfg'].shrToken)
|
||||
super(MonkeyPatch, self).__init__(bindings={(opts['cfg'].bindHost, opts['cfg'].bindPort): cfg}, *args, **kwargs)
|
||||
|
||||
def __enter__(self):
|
||||
return self
|
||||
|
||||
def __exit__(self, exc_type, exc_val, exc_tb):
|
||||
super(MonkeyPatch, self).__exit__(exc_type, exc_val, exc_tb)
|
||||
|
||||
|
||||
def zrok(opts: {}, *zargs, **zkwargs):
|
||||
def zrockify_func(func):
|
||||
def zrockified(*args, **kwargs):
|
||||
with MonkeyPatch(opts=opts, *zargs, **zkwargs):
|
||||
func(*args, **kwargs)
|
||||
return zrockified
|
||||
return zrockify_func
|
@ -2,8 +2,9 @@ from zrok.environment.root import Root
|
||||
import openziti
|
||||
from socket import SOCK_STREAM
|
||||
|
||||
|
||||
def Dialer(shrToken: str, root: Root) -> openziti.zitisock.ZitiSocket:
|
||||
openziti.load(root.ZitiIdentityNamed(root.EnvironmentIdentityName()))
|
||||
client = openziti.socket(type = SOCK_STREAM)
|
||||
client = openziti.socket(type=SOCK_STREAM)
|
||||
client.connect((shrToken, 1))
|
||||
return client
|
||||
return client
|
||||
|
@ -1 +1 @@
|
||||
from . import dirs, root
|
||||
from . import dirs, root # noqa
|
||||
|
@ -1,26 +1,32 @@
|
||||
from pathlib import Path
|
||||
import os
|
||||
|
||||
|
||||
def rootDir() -> str:
|
||||
home = str(Path.home())
|
||||
return os.path.join(home, ".zrok")
|
||||
|
||||
|
||||
def metadataFile() -> str:
|
||||
zrd = rootDir()
|
||||
return os.path.join(zrd, "metadata.json")
|
||||
|
||||
|
||||
def configFile() -> str:
|
||||
zrd = rootDir()
|
||||
return os.path.join(zrd, "config.json")
|
||||
|
||||
|
||||
def environmentFile() -> str:
|
||||
zrd = rootDir()
|
||||
return os.path.join(zrd, "environment.json")
|
||||
|
||||
|
||||
def identitiesDir() -> str:
|
||||
zrd = rootDir()
|
||||
return os.path.join(zrd, "identities")
|
||||
|
||||
|
||||
def identityFile(name: str) -> str:
|
||||
idd = identitiesDir()
|
||||
return os.path.join(idd, name + ".json")
|
||||
return os.path.join(idd, name + ".json")
|
||||
|
@ -1,6 +1,6 @@
|
||||
from dataclasses import dataclass, field
|
||||
from typing import NamedTuple
|
||||
from .dirs import *
|
||||
from .dirs import identityFile, rootDir, configFile, environmentFile, metadataFile
|
||||
import os
|
||||
import json
|
||||
import zrok_api as zrok
|
||||
@ -9,25 +9,30 @@ import re
|
||||
|
||||
V = "v0.4"
|
||||
|
||||
|
||||
@dataclass
|
||||
class Metadata:
|
||||
V: str = ""
|
||||
RootPath: str = ""
|
||||
|
||||
|
||||
@dataclass
|
||||
class Config:
|
||||
ApiEndpoint: str = ""
|
||||
|
||||
|
||||
@dataclass
|
||||
class Environment:
|
||||
Token: str = ""
|
||||
ZitiIdentity: str = ""
|
||||
ApiEndpoint: str = ""
|
||||
|
||||
|
||||
class ApiEndpoint(NamedTuple):
|
||||
endpoint: str
|
||||
frm: str
|
||||
|
||||
|
||||
@dataclass
|
||||
class Root:
|
||||
meta: Metadata = field(default_factory=Metadata)
|
||||
@ -36,7 +41,7 @@ class Root:
|
||||
|
||||
def HasConfig(self) -> bool:
|
||||
return self.cfg != Config()
|
||||
|
||||
|
||||
def Client(self) -> zrok.ApiClient:
|
||||
apiEndpoint = self.ApiEndpoint()
|
||||
|
||||
@ -45,14 +50,13 @@ class Root:
|
||||
cfg.api_key["x-token"] = self.env.Token
|
||||
cfg.api_key_prefix['Authorization'] = 'Bearer'
|
||||
|
||||
|
||||
zrock_client = zrok.ApiClient(configuration=cfg)
|
||||
v = zrok.MetadataApi(zrock_client).version()
|
||||
# allow reported version string to be optionally prefixed with
|
||||
# "refs/heads/" or "refs/tags/"
|
||||
# "refs/heads/" or "refs/tags/"
|
||||
rxp = re.compile("^(refs/(heads|tags)/)?" + V)
|
||||
if not rxp.match(v):
|
||||
raise Exception("Expected a '" + V + "' version, received: '" + v+ "'")
|
||||
raise Exception("expected a '" + V + "' version, received: '" + v + "'")
|
||||
return zrock_client
|
||||
|
||||
def ApiEndpoint(self) -> ApiEndpoint:
|
||||
@ -73,25 +77,27 @@ class Root:
|
||||
frm = "env"
|
||||
|
||||
return ApiEndpoint(apiEndpoint.rstrip("/"), frm)
|
||||
|
||||
|
||||
def IsEnabled(self) -> bool:
|
||||
return self.env != Environment()
|
||||
|
||||
|
||||
def PublicIdentityName(self) -> str:
|
||||
return "public"
|
||||
|
||||
|
||||
def EnvironmentIdentityName(self) -> str:
|
||||
return "environment"
|
||||
|
||||
|
||||
def ZitiIdentityNamed(self, name: str) -> str:
|
||||
return identityFile(name)
|
||||
|
||||
|
||||
def Default() -> Root:
|
||||
r = Root()
|
||||
root = rootDir()
|
||||
r.meta = Metadata(V=V, RootPath=root)
|
||||
return r
|
||||
|
||||
|
||||
def Assert() -> bool:
|
||||
exists = __rootExists()
|
||||
if exists:
|
||||
@ -99,6 +105,7 @@ def Assert() -> bool:
|
||||
return meta.V == V
|
||||
return False
|
||||
|
||||
|
||||
def Load() -> Root:
|
||||
r = Root()
|
||||
if __rootExists():
|
||||
@ -109,31 +116,40 @@ def Load() -> Root:
|
||||
r = Default()
|
||||
return r
|
||||
|
||||
|
||||
def __rootExists() -> bool:
|
||||
mf = metadataFile()
|
||||
return os.path.isfile(mf)
|
||||
|
||||
|
||||
def __assertMetadata():
|
||||
pass
|
||||
|
||||
|
||||
def __loadMetadata() -> Metadata:
|
||||
mf = metadataFile()
|
||||
with open(mf) as f:
|
||||
data = json.load(f)
|
||||
return Metadata(V=data["v"])
|
||||
|
||||
|
||||
|
||||
def __loadConfig() -> Config:
|
||||
cf = configFile()
|
||||
with open(cf) as f:
|
||||
data = json.load(f)
|
||||
return Config(ApiEndpoint=data["api_endpoint"])
|
||||
|
||||
|
||||
|
||||
def isEnabled() -> bool:
|
||||
ef = environmentFile()
|
||||
return os.path.isfile(ef)
|
||||
|
||||
|
||||
def __loadEnvironment() -> Environment:
|
||||
ef = environmentFile()
|
||||
with open(ef) as f:
|
||||
data = json.load(f)
|
||||
return Environment(Token=data["zrok_token"], ZitiIdentity=data["ziti_identity"], ApiEndpoint=data["api_endpoint"])
|
||||
return Environment(
|
||||
Token=data["zrok_token"],
|
||||
ZitiIdentity=data["ziti_identity"],
|
||||
ApiEndpoint=data["api_endpoint"])
|
||||
|
@ -10,7 +10,9 @@ class Listener():
|
||||
def __init__(self, shrToken: str, root: Root):
|
||||
self.shrToken = shrToken
|
||||
self.root = root
|
||||
ztx = openziti.load(self.root.ZitiIdentityNamed(self.root.EnvironmentIdentityName()))
|
||||
ztx = openziti.load(
|
||||
self.root.ZitiIdentityNamed(
|
||||
self.root.EnvironmentIdentityName()))
|
||||
self.__server = ztx.bind(self.shrToken)
|
||||
|
||||
def __enter__(self) -> openziti.zitisock.ZitiSocket:
|
||||
|
@ -13,6 +13,7 @@ ShareMode = str
|
||||
PRIVATE_SHARE_MODE: ShareMode = "private"
|
||||
PUBLIC_SHARE_MODE: ShareMode = "public"
|
||||
|
||||
|
||||
@dataclass
|
||||
class ShareRequest:
|
||||
BackendMode: BackendMode
|
||||
@ -26,34 +27,40 @@ class ShareRequest:
|
||||
Reserved: bool = False
|
||||
UniqueName: str = ""
|
||||
|
||||
|
||||
@dataclass
|
||||
class Share:
|
||||
Token: str
|
||||
FrontendEndpoints: list[str]
|
||||
|
||||
|
||||
@dataclass
|
||||
class AccessRequest:
|
||||
ShareToken: str
|
||||
|
||||
|
||||
@dataclass
|
||||
class Access:
|
||||
Token: str
|
||||
ShareToken: str
|
||||
BackendMode: BackendMode
|
||||
|
||||
|
||||
@dataclass
|
||||
class SessionMetrics:
|
||||
BytesRead: int
|
||||
BytesWritten: int
|
||||
LastUpdate: int
|
||||
|
||||
|
||||
@dataclass
|
||||
class Metrics:
|
||||
Namespace: str
|
||||
Sessions: dict[str, SessionMetrics]
|
||||
|
||||
|
||||
AuthScheme = str
|
||||
|
||||
AUTH_SCHEME_NONE: AuthScheme = "none"
|
||||
AUTH_SCHEME_BASIC: AuthScheme = "basic"
|
||||
AUTH_SCHEME_OAUTH: AuthScheme = "oauth"
|
||||
AUTH_SCHEME_OAUTH: AuthScheme = "oauth"
|
||||
|
@ -1,9 +1,11 @@
|
||||
from zrok.environment.root import Root
|
||||
import urllib3
|
||||
|
||||
|
||||
def Overview(root: Root) -> str:
|
||||
if not root.IsEnabled():
|
||||
raise Exception("environment is not enabled; enable with 'zrok enable' first!")
|
||||
|
||||
|
||||
http = urllib3.PoolManager()
|
||||
apiEndpoint = root.ApiEndpoint().endpoint
|
||||
try:
|
||||
@ -15,4 +17,4 @@ def Overview(root: Root) -> str:
|
||||
})
|
||||
except Exception as e:
|
||||
raise Exception("unable to get account overview", e)
|
||||
return response.data.decode('utf-8')
|
||||
return response.data.decode('utf-8')
|
||||
|
@ -3,10 +3,29 @@ from zrok_api.models import ShareRequest, UnshareRequest, AuthUser
|
||||
from zrok_api.api import ShareApi
|
||||
from zrok import model
|
||||
|
||||
|
||||
class Share():
|
||||
root: Root
|
||||
request: model.ShareRequest
|
||||
share: model.Share
|
||||
|
||||
def __init__(self, root: Root, request: model.ShareRequest):
|
||||
self.root = root
|
||||
self.request = request
|
||||
|
||||
def __enter__(self) -> model.Share:
|
||||
self.share = CreateShare(root=self.root, request=self.request)
|
||||
return self.share
|
||||
|
||||
def __exit__(self, exception_type, exception_value, exception_traceback):
|
||||
if not self.request.Reserved:
|
||||
DeleteShare(root=self.root, shr=self.share)
|
||||
|
||||
|
||||
def CreateShare(root: Root, request: model.ShareRequest) -> model.Share:
|
||||
if not root.IsEnabled():
|
||||
raise Exception("environment is not enabled; enable with 'zrok enable' first!")
|
||||
|
||||
|
||||
match request.ShareMode:
|
||||
case model.PRIVATE_SHARE_MODE:
|
||||
out = __newPrivateShare(root, request)
|
||||
@ -25,7 +44,7 @@ def CreateShare(root: Root, request: model.ShareRequest) -> model.Share:
|
||||
if len(tokens) == 2:
|
||||
out.auth_users.append(AuthUser(username=tokens[0].strip(), password=tokens[1].strip()))
|
||||
else:
|
||||
raise Exception("invalid username:password pair: " + pair)
|
||||
raise Exception("invalid username:password pair: " + pair)
|
||||
|
||||
if request.OauthProvider != "":
|
||||
out.auth_scheme = model.AUTH_SCHEME_OAUTH
|
||||
@ -38,29 +57,30 @@ def CreateShare(root: Root, request: model.ShareRequest) -> model.Share:
|
||||
res = ShareApi(zrok).share(body=out)
|
||||
except Exception as e:
|
||||
raise Exception("unable to create share", e)
|
||||
|
||||
|
||||
return model.Share(Token=res.shr_token,
|
||||
FrontendEndpoints=res.frontend_proxy_endpoints)
|
||||
|
||||
|
||||
|
||||
|
||||
def __newPrivateShare(root: Root, request: model.ShareRequest) -> ShareRequest:
|
||||
return ShareRequest(env_zid=root.env.ZitiIdentity,
|
||||
share_mode=request.ShareMode,
|
||||
backend_mode=request.BackendMode,
|
||||
backend_proxy_endpoint=request.Target,
|
||||
auth_scheme=model.AUTH_SCHEME_NONE
|
||||
)
|
||||
share_mode=request.ShareMode,
|
||||
backend_mode=request.BackendMode,
|
||||
backend_proxy_endpoint=request.Target,
|
||||
auth_scheme=model.AUTH_SCHEME_NONE
|
||||
)
|
||||
|
||||
|
||||
def __newPublicShare(root: Root, request: model.ShareRequest) -> ShareRequest:
|
||||
ret= ShareRequest(env_zid=root.env.ZitiIdentity,
|
||||
share_mode=request.ShareMode,
|
||||
frontend_selection=request.Frontends,
|
||||
backend_mode=request.BackendMode,
|
||||
backend_proxy_endpoint=request.Target,
|
||||
auth_scheme=model.AUTH_SCHEME_NONE,
|
||||
oauth_email_domains=request.OauthEmailDomains,
|
||||
oauth_authorization_check_interval=request.OauthAuthorizationCheckInterval
|
||||
)
|
||||
ret = ShareRequest(env_zid=root.env.ZitiIdentity,
|
||||
share_mode=request.ShareMode,
|
||||
frontend_selection=request.Frontends,
|
||||
backend_mode=request.BackendMode,
|
||||
backend_proxy_endpoint=request.Target,
|
||||
auth_scheme=model.AUTH_SCHEME_NONE,
|
||||
oauth_email_domains=request.OauthEmailDomains,
|
||||
oauth_authorization_check_interval=request.OauthAuthorizationCheckInterval
|
||||
)
|
||||
if request.OauthProvider != "":
|
||||
ret.oauth_provider = request.OauthProvider
|
||||
|
||||
@ -70,13 +90,13 @@ def __newPublicShare(root: Root, request: model.ShareRequest) -> ShareRequest:
|
||||
def DeleteShare(root: Root, shr: model.Share):
|
||||
req = UnshareRequest(env_zid=root.env.ZitiIdentity,
|
||||
shr_token=shr.Token)
|
||||
|
||||
|
||||
try:
|
||||
zrok = root.Client()
|
||||
except Exception as e:
|
||||
raise Exception("error getting zrok client", e)
|
||||
|
||||
|
||||
try:
|
||||
ShareApi(zrok).unshare(body=req)
|
||||
except Exception as e:
|
||||
raise Exception("error deleting share", e)
|
||||
raise Exception("error deleting share", e)
|
||||
|
Loading…
Reference in New Issue
Block a user