From ed8c26362cfa1a9efc912907851b00c64180e367 Mon Sep 17 00:00:00 2001 From: Olivier Desenfans Date: Wed, 6 Sep 2023 12:35:17 +0200 Subject: [PATCH] Internal: CI/CD, tests and packaging The project is now structured as an `aleph_vrf` module that contains the coordinator and executor code. Added setup files using PyScaffold and a structure to run unit tests with pytest. Added a CI/CD pipeline for these unit tests. --- .coveragerc | 28 ++ .github/workflows/unit-tests.yml | 25 ++ .gitignore | 54 ++++ .readthedocs.yml | 27 ++ AUTHORS.rst | 6 + CHANGELOG.rst | 6 + LICENSE.txt | 21 ++ README.rst | 49 +++ docs/Makefile | 29 ++ docs/_static/.gitignore | 1 + docs/authors.rst | 2 + docs/changelog.rst | 2 + docs/conf.py | 286 ++++++++++++++++++ docs/contributing.rst | 1 + docs/index.rst | 61 ++++ docs/license.rst | 7 + docs/readme.rst | 2 + docs/requirements.txt | 5 + pyproject.toml | 9 + setup.cfg | 131 ++++++++ setup.py | 21 ++ src/aleph_vrf/__init__.py | 16 + src/aleph_vrf/coordinator/__init__.py | 0 .../aleph_vrf/coordinator}/main.py | 4 +- vrf.py => src/aleph_vrf/coordinator/vrf.py | 52 ++-- src/aleph_vrf/executor/__init__.py | 0 .../aleph_vrf/executor}/main.py | 4 +- models.py => src/aleph_vrf/models.py | 0 utils.py => src/aleph_vrf/utils.py | 0 tests/conftest.py | 10 + tests/coordinator/test_vrf.py | 128 ++++++++ tox.ini | 93 ++++++ 32 files changed, 1049 insertions(+), 31 deletions(-) create mode 100644 .coveragerc create mode 100644 .github/workflows/unit-tests.yml create mode 100644 .readthedocs.yml create mode 100644 AUTHORS.rst create mode 100644 CHANGELOG.rst create mode 100644 LICENSE.txt create mode 100644 README.rst create mode 100644 docs/Makefile create mode 100644 docs/_static/.gitignore create mode 100644 docs/authors.rst create mode 100644 docs/changelog.rst create mode 100644 docs/conf.py create mode 100644 docs/contributing.rst create mode 100644 docs/index.rst create mode 100644 docs/license.rst create mode 100644 docs/readme.rst create mode 100644 docs/requirements.txt create mode 100644 pyproject.toml create mode 100644 setup.cfg create mode 100644 setup.py create mode 100644 src/aleph_vrf/__init__.py create mode 100644 src/aleph_vrf/coordinator/__init__.py rename {coordinator => src/aleph_vrf/coordinator}/main.py (90%) rename vrf.py => src/aleph_vrf/coordinator/vrf.py (85%) create mode 100644 src/aleph_vrf/executor/__init__.py rename {generate-function => src/aleph_vrf/executor}/main.py (97%) rename models.py => src/aleph_vrf/models.py (100%) rename utils.py => src/aleph_vrf/utils.py (100%) create mode 100644 tests/conftest.py create mode 100644 tests/coordinator/test_vrf.py create mode 100644 tox.ini diff --git a/.coveragerc b/.coveragerc new file mode 100644 index 0000000..6554d34 --- /dev/null +++ b/.coveragerc @@ -0,0 +1,28 @@ +# .coveragerc to control coverage.py +[run] +branch = True +source = aleph_vrf +# omit = bad_file.py + +[paths] +source = + src/ + */site-packages/ + +[report] +# Regexes for lines to exclude from consideration +exclude_lines = + # Have to re-enable the standard pragma + pragma: no cover + + # Don't complain about missing debug-only code: + def __repr__ + if self\.debug + + # Don't complain if tests don't hit defensive assertion code: + raise AssertionError + raise NotImplementedError + + # Don't complain if non-runnable code isn't run: + if 0: + if __name__ == .__main__.: diff --git a/.github/workflows/unit-tests.yml b/.github/workflows/unit-tests.yml new file mode 100644 index 0000000..ae8e6e7 --- /dev/null +++ b/.github/workflows/unit-tests.yml @@ -0,0 +1,25 @@ +name: Unit tests + +on: [push] + +jobs: + build: + + runs-on: ubuntu-22.04 + strategy: + matrix: + python-version: ["3.8", "3.9", "3.10", "3.11"] + + steps: + - uses: actions/checkout@v3 + - name: Set up Python ${{ matrix.python-version }} + uses: actions/setup-python@v4 + with: + python-version: ${{ matrix.python-version }} + - name: Install dependencies + run: | + python -m pip install --upgrade pip + pip install -e .[testing] + - name: Test with pytest + run: | + pytest diff --git a/.gitignore b/.gitignore index 485dee6..5b0f7ee 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,55 @@ +# Temporary and binary files +*~ +*.py[cod] +*.so +*.cfg +!.isort.cfg +!setup.cfg +*.orig +*.log +*.pot +__pycache__/* +.cache/* +.*.swp +*/.ipynb_checkpoints/* +.DS_Store + +# Project files +.ropeproject +.project +.pydevproject +.settings .idea +.vscode +tags + +# Package files +*.egg +*.eggs/ +.installed.cfg +*.egg-info + +# Unittest and coverage +htmlcov/* +.coverage +.coverage.* +.tox +junit*.xml +coverage.xml +.pytest_cache/ + +# Build and docs folder/files +build/* +dist/* +sdist/* +docs/api/* +docs/_rst/* +docs/_build/* +cover/* +MANIFEST + +# Per-project virtualenvs +.venv*/ +venv/ +.conda*/ +.python-version diff --git a/.readthedocs.yml b/.readthedocs.yml new file mode 100644 index 0000000..a2bcab3 --- /dev/null +++ b/.readthedocs.yml @@ -0,0 +1,27 @@ +# Read the Docs configuration file +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +# Required +version: 2 + +# Build documentation in the docs/ directory with Sphinx +sphinx: + configuration: docs/conf.py + +# Build documentation with MkDocs +#mkdocs: +# configuration: mkdocs.yml + +# Optionally build your docs in additional formats such as PDF +formats: + - pdf + +build: + os: ubuntu-22.04 + tools: + python: "3.11" + +python: + install: + - requirements: docs/requirements.txt + - {path: ., method: pip} diff --git a/AUTHORS.rst b/AUTHORS.rst new file mode 100644 index 0000000..e33fb27 --- /dev/null +++ b/AUTHORS.rst @@ -0,0 +1,6 @@ +============ +Contributors +============ + +* Olivier Desenfans +* Andres Molins diff --git a/CHANGELOG.rst b/CHANGELOG.rst new file mode 100644 index 0000000..1396ed6 --- /dev/null +++ b/CHANGELOG.rst @@ -0,0 +1,6 @@ +========= +Changelog +========= + +Current version +=============== diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..07be17d --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,21 @@ +The MIT License (MIT) + +Copyright (c) 2023 Andres Molins + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..27d44d9 --- /dev/null +++ b/README.rst @@ -0,0 +1,49 @@ +.. These are examples of badges you might want to add to your README: + please update the URLs accordingly + + .. image:: https://api.cirrus-ci.com/github//aleph-vrf.svg?branch=main + :alt: Built Status + :target: https://cirrus-ci.com/github//aleph-vrf + .. image:: https://readthedocs.org/projects/aleph-vrf/badge/?version=latest + :alt: ReadTheDocs + :target: https://aleph-vrf.readthedocs.io/en/stable/ + .. image:: https://img.shields.io/coveralls/github//aleph-vrf/main.svg + :alt: Coveralls + :target: https://coveralls.io/r//aleph-vrf + .. image:: https://img.shields.io/pypi/v/aleph-vrf.svg + :alt: PyPI-Server + :target: https://pypi.org/project/aleph-vrf/ + .. image:: https://img.shields.io/conda/vn/conda-forge/aleph-vrf.svg + :alt: Conda-Forge + :target: https://anaconda.org/conda-forge/aleph-vrf + .. image:: https://pepy.tech/badge/aleph-vrf/month + :alt: Monthly Downloads + :target: https://pepy.tech/project/aleph-vrf + .. image:: https://img.shields.io/twitter/url/http/shields.io.svg?style=social&label=Twitter + :alt: Twitter + :target: https://twitter.com/aleph-vrf + +.. image:: https://img.shields.io/badge/-PyScaffold-005CA0?logo=pyscaffold + :alt: Project generated with PyScaffold + :target: https://pyscaffold.org/ + +| + +========= +aleph-vrf +========= + + + Aleph.im Verifiable Random Function + + +A longer description of your project goes here... + + +.. _pyscaffold-notes: + +Note +==== + +This project has been set up using PyScaffold 4.5. For details and usage +information on PyScaffold see https://pyscaffold.org/. diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..31655dd --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,29 @@ +# Makefile for Sphinx documentation +# + +# You can set these variables from the command line, and also +# from the environment for the first two. +SPHINXOPTS ?= +SPHINXBUILD ?= sphinx-build +SOURCEDIR = . +BUILDDIR = _build +AUTODOCDIR = api + +# User-friendly check for sphinx-build +ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $?), 1) +$(error "The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from https://sphinx-doc.org/") +endif + +.PHONY: help clean Makefile + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +clean: + rm -rf $(BUILDDIR)/* $(AUTODOCDIR) + +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/docs/_static/.gitignore b/docs/_static/.gitignore new file mode 100644 index 0000000..3c96363 --- /dev/null +++ b/docs/_static/.gitignore @@ -0,0 +1 @@ +# Empty directory diff --git a/docs/authors.rst b/docs/authors.rst new file mode 100644 index 0000000..cd8e091 --- /dev/null +++ b/docs/authors.rst @@ -0,0 +1,2 @@ +.. _authors: +.. include:: ../AUTHORS.rst diff --git a/docs/changelog.rst b/docs/changelog.rst new file mode 100644 index 0000000..871950d --- /dev/null +++ b/docs/changelog.rst @@ -0,0 +1,2 @@ +.. _changes: +.. include:: ../CHANGELOG.rst diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..5fe4136 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,286 @@ +# This file is execfile()d with the current directory set to its containing dir. +# +# This file only contains a selection of the most common options. For a full +# list see the documentation: +# https://www.sphinx-doc.org/en/master/usage/configuration.html +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +import os +import sys +import shutil + +# -- Path setup -------------------------------------------------------------- + +__location__ = os.path.dirname(__file__) + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +sys.path.insert(0, os.path.join(__location__, "../src")) + +# -- Run sphinx-apidoc ------------------------------------------------------- +# This hack is necessary since RTD does not issue `sphinx-apidoc` before running +# `sphinx-build -b html . _build/html`. See Issue: +# https://github.com/readthedocs/readthedocs.org/issues/1139 +# DON'T FORGET: Check the box "Install your project inside a virtualenv using +# setup.py install" in the RTD Advanced Settings. +# Additionally it helps us to avoid running apidoc manually + +try: # for Sphinx >= 1.7 + from sphinx.ext import apidoc +except ImportError: + from sphinx import apidoc + +output_dir = os.path.join(__location__, "api") +module_dir = os.path.join(__location__, "../src/aleph_vrf") +try: + shutil.rmtree(output_dir) +except FileNotFoundError: + pass + +try: + import sphinx + + cmd_line = f"sphinx-apidoc --implicit-namespaces -f -o {output_dir} {module_dir}" + + args = cmd_line.split(" ") + if tuple(sphinx.__version__.split(".")) >= ("1", "7"): + # This is a rudimentary parse_version to avoid external dependencies + args = args[1:] + + apidoc.main(args) +except Exception as e: + print("Running `sphinx-apidoc` failed!\n{}".format(e)) + +# -- General configuration --------------------------------------------------- + +# If your documentation needs a minimal Sphinx version, state it here. +# needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be extensions +# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. +extensions = [ + "sphinx.ext.autodoc", + "sphinx.ext.intersphinx", + "sphinx.ext.todo", + "sphinx.ext.autosummary", + "sphinx.ext.viewcode", + "sphinx.ext.coverage", + "sphinx.ext.doctest", + "sphinx.ext.ifconfig", + "sphinx.ext.mathjax", + "sphinx.ext.napoleon", +] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ["_templates"] + +# The suffix of source filenames. +source_suffix = ".rst" + +# The encoding of source files. +# source_encoding = 'utf-8-sig' + +# The master toctree document. +master_doc = "index" + +# General information about the project. +project = "aleph-vrf" +copyright = "2023, Olivier Desenfans" + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# version: The short X.Y version. +# release: The full version, including alpha/beta/rc tags. +# If you don’t need the separation provided between version and release, +# just set them both to the same value. +try: + from aleph_vrf import __version__ as version +except ImportError: + version = "" + +if not version or version.lower() == "unknown": + version = os.getenv("READTHEDOCS_VERSION", "unknown") # automatically set by RTD + +release = version + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# language = None + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +# today = '' +# Else, today_fmt is used as the format for a strftime call. +# today_fmt = '%B %d, %Y' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", ".venv"] + +# The reST default role (used for this markup: `text`) to use for all documents. +# default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +# add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +# add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +# show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = "sphinx" + +# A list of ignored prefixes for module index sorting. +# modindex_common_prefix = [] + +# If true, keep warnings as "system message" paragraphs in the built documents. +# keep_warnings = False + +# If this is True, todo emits a warning for each TODO entries. The default is False. +todo_emit_warnings = True + + +# -- Options for HTML output ------------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +html_theme = "alabaster" + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +html_theme_options = { + "sidebar_width": "300px", + "page_width": "1200px" +} + +# Add any paths that contain custom themes here, relative to this directory. +# html_theme_path = [] + +# The name for this set of Sphinx documents. If None, it defaults to +# " v documentation". +# html_title = None + +# A shorter title for the navigation bar. Default is the same as html_title. +# html_short_title = None + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +# html_logo = "" + +# The name of an image file (within the static path) to use as favicon of the +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +# html_favicon = None + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ["_static"] + +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +# html_last_updated_fmt = '%b %d, %Y' + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +# html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +# html_sidebars = {} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +# html_additional_pages = {} + +# If false, no module index is generated. +# html_domain_indices = True + +# If false, no index is generated. +# html_use_index = True + +# If true, the index is split into individual pages for each letter. +# html_split_index = False + +# If true, links to the reST sources are added to the pages. +# html_show_sourcelink = True + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +# html_show_sphinx = True + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +# html_show_copyright = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +# html_use_opensearch = '' + +# This is the file name suffix for HTML files (e.g. ".xhtml"). +# html_file_suffix = None + +# Output file base name for HTML help builder. +htmlhelp_basename = "aleph-vrf-doc" + + +# -- Options for LaTeX output ------------------------------------------------ + +latex_elements = { + # The paper size ("letterpaper" or "a4paper"). + # "papersize": "letterpaper", + # The font size ("10pt", "11pt" or "12pt"). + # "pointsize": "10pt", + # Additional stuff for the LaTeX preamble. + # "preamble": "", +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, author, documentclass [howto/manual]). +latex_documents = [ + ("index", "user_guide.tex", "aleph-vrf Documentation", "Olivier Desenfans", "manual") +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +# latex_logo = "" + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +# latex_use_parts = False + +# If true, show page references after internal links. +# latex_show_pagerefs = False + +# If true, show URL addresses after external links. +# latex_show_urls = False + +# Documents to append as an appendix to all manuals. +# latex_appendices = [] + +# If false, no module index is generated. +# latex_domain_indices = True + +# -- External mapping -------------------------------------------------------- +python_version = ".".join(map(str, sys.version_info[0:2])) +intersphinx_mapping = { + "sphinx": ("https://www.sphinx-doc.org/en/master", None), + "python": ("https://docs.python.org/" + python_version, None), + "matplotlib": ("https://matplotlib.org", None), + "numpy": ("https://numpy.org/doc/stable", None), + "sklearn": ("https://scikit-learn.org/stable", None), + "pandas": ("https://pandas.pydata.org/pandas-docs/stable", None), + "scipy": ("https://docs.scipy.org/doc/scipy/reference", None), + "setuptools": ("https://setuptools.pypa.io/en/stable/", None), + "pyscaffold": ("https://pyscaffold.org/en/stable", None), +} + +print(f"loading configurations for {project} {version} ...", file=sys.stderr) diff --git a/docs/contributing.rst b/docs/contributing.rst new file mode 100644 index 0000000..e582053 --- /dev/null +++ b/docs/contributing.rst @@ -0,0 +1 @@ +.. include:: ../CONTRIBUTING.rst diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..949cd3b --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,61 @@ +========= +aleph-vrf +========= + +This is the documentation of **aleph-vrf**. + +.. note:: + + This is the main page of your project's `Sphinx`_ documentation. + It is formatted in `reStructuredText`_. Add additional pages + by creating rst-files in ``docs`` and adding them to the `toctree`_ below. + Use then `references`_ in order to link them from this page, e.g. + :ref:`authors` and :ref:`changes`. + + It is also possible to refer to the documentation of other Python packages + with the `Python domain syntax`_. By default you can reference the + documentation of `Sphinx`_, `Python`_, `NumPy`_, `SciPy`_, `matplotlib`_, + `Pandas`_, `Scikit-Learn`_. You can add more by extending the + ``intersphinx_mapping`` in your Sphinx's ``conf.py``. + + The pretty useful extension `autodoc`_ is activated by default and lets + you include documentation from docstrings. Docstrings can be written in + `Google style`_ (recommended!), `NumPy style`_ and `classical style`_. + + +Contents +======== + +.. toctree:: + :maxdepth: 2 + + Overview + Contributions & Help + License + Authors + Changelog + Module Reference + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` + +.. _toctree: https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html +.. _reStructuredText: https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html +.. _references: https://www.sphinx-doc.org/en/stable/markup/inline.html +.. _Python domain syntax: https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#the-python-domain +.. _Sphinx: https://www.sphinx-doc.org/ +.. _Python: https://docs.python.org/ +.. _Numpy: https://numpy.org/doc/stable +.. _SciPy: https://docs.scipy.org/doc/scipy/reference/ +.. _matplotlib: https://matplotlib.org/contents.html# +.. _Pandas: https://pandas.pydata.org/pandas-docs/stable +.. _Scikit-Learn: https://scikit-learn.org/stable +.. _autodoc: https://www.sphinx-doc.org/en/master/ext/autodoc.html +.. _Google style: https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings +.. _NumPy style: https://numpydoc.readthedocs.io/en/latest/format.html +.. _classical style: https://www.sphinx-doc.org/en/master/domains.html#info-field-lists diff --git a/docs/license.rst b/docs/license.rst new file mode 100644 index 0000000..3989c51 --- /dev/null +++ b/docs/license.rst @@ -0,0 +1,7 @@ +.. _license: + +======= +License +======= + +.. include:: ../LICENSE.txt diff --git a/docs/readme.rst b/docs/readme.rst new file mode 100644 index 0000000..81995ef --- /dev/null +++ b/docs/readme.rst @@ -0,0 +1,2 @@ +.. _readme: +.. include:: ../README.rst diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 0000000..2ddf98a --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,5 @@ +# Requirements file for ReadTheDocs, check .readthedocs.yml. +# To build the module reference correctly, make sure every external package +# under `install_requires` in `setup.cfg` is also listed here! +sphinx>=3.2.1 +# sphinx_rtd_theme diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..89a5bed --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,9 @@ +[build-system] +# AVOID CHANGING REQUIRES: IT WILL BE UPDATED BY PYSCAFFOLD! +requires = ["setuptools>=46.1.0", "setuptools_scm[toml]>=5"] +build-backend = "setuptools.build_meta" + +[tool.setuptools_scm] +# For smarter version schemes and other configuration options, +# check out https://github.com/pypa/setuptools_scm +version_scheme = "no-guess-dev" diff --git a/setup.cfg b/setup.cfg new file mode 100644 index 0000000..1c58c89 --- /dev/null +++ b/setup.cfg @@ -0,0 +1,131 @@ +# This file is used to configure your project. +# Read more about the various options under: +# https://setuptools.pypa.io/en/latest/userguide/declarative_config.html +# https://setuptools.pypa.io/en/latest/references/keywords.html + +[metadata] +name = aleph-vrf +description = Aleph.im Verifiable Random Function +author = Andres Molins +author_email = desenfans.olivier@gmail.com +license = MIT +license_files = LICENSE.txt +long_description = file: README.rst +long_description_content_type = text/x-rst; charset=UTF-8 +url = https://github.com/pyscaffold/pyscaffold/ +# Add here related links, for example: +project_urls = + Documentation = https://pyscaffold.org/ +# Source = https://github.com/pyscaffold/pyscaffold/ +# Changelog = https://pyscaffold.org/en/latest/changelog.html +# Tracker = https://github.com/pyscaffold/pyscaffold/issues +# Conda-Forge = https://anaconda.org/conda-forge/pyscaffold +# Download = https://pypi.org/project/PyScaffold/#files +# Twitter = https://twitter.com/PyScaffold + +# Change if running only on Windows, Mac or Linux (comma-separated) +platforms = any + +# Add here all kinds of additional classifiers as defined under +# https://pypi.org/classifiers/ +classifiers = + Development Status :: 4 - Beta + Programming Language :: Python + + +[options] +zip_safe = False +packages = find_namespace: +include_package_data = True +package_dir = + =src + +# Require a min/specific Python version (comma-separated conditions) +# python_requires = >=3.8 + +# Add here dependencies of your project (line-separated), e.g. requests>=2.2,<3.0. +# Version specifiers like >=2.2,<3.0 avoid problems due to API changes in +# new major versions. This works if the required packages follow Semantic Versioning. +# For more information, check out https://semver.org/. +install_requires = + aiohttp + aleph-sdk-python==0.7.0 + fastapi + importlib-metadata; python_version<"3.8" + utilitybelt + + +[options.packages.find] +where = src +exclude = + tests + +[options.extras_require] +# Add here additional requirements for extra features, to install with: +# `pip install aleph-vrf[PDF]` like: +# PDF = ReportLab; RXP + +# Add here test requirements (semicolon/line-separated) +testing = + setuptools + pytest + pytest-asyncio + pytest-cov + pytest-mock + +[options.entry_points] +# Add here console scripts like: +# console_scripts = +# script_name = aleph_vrf.module:function +# For example: +# console_scripts = +# fibonacci = aleph_vrf.skeleton:run +# And any other entry points, for example: +# pyscaffold.cli = +# awesome = pyscaffoldext.awesome.extension:AwesomeExtension + +[tool:pytest] +# Specify command line options as you would do when invoking pytest directly. +# e.g. --cov-report html (or xml) for html/xml output or --junitxml junit.xml +# in order to write a coverage file that can be read by Jenkins. +# CAUTION: --cov flags may prohibit setting breakpoints while debugging. +# Comment those flags to avoid this pytest issue. +addopts = + --cov aleph_vrf --cov-report term-missing + --verbose +norecursedirs = + dist + build + .tox +testpaths = tests +# Use pytest markers to select/deselect specific tests +# markers = +# slow: mark tests as slow (deselect with '-m "not slow"') +# system: mark end-to-end system tests + +[devpi:upload] +# Options for the devpi: PyPI server and packaging tool +# VCS export must be deactivated since we are using setuptools-scm +no_vcs = 1 +formats = bdist_wheel + +[flake8] +# Some sane defaults for the code style checker flake8 +max_line_length = 88 +extend_ignore = E203, W503 +# ^ Black-compatible +# E203 and W503 have edge cases handled by black +exclude = + .tox + build + dist + .eggs + docs/conf.py + +[pyscaffold] +# PyScaffold's parameters when the project was created. +# This will be used when updating. Do not change! +version = 4.5 +package = aleph_vrf +extensions = + no_skeleton diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..a7301ed --- /dev/null +++ b/setup.py @@ -0,0 +1,21 @@ +""" + Setup file for aleph-vrf. + Use setup.cfg to configure your project. + + This file was generated with PyScaffold 4.5. + PyScaffold helps you to put up the scaffold of your new Python project. + Learn more under: https://pyscaffold.org/ +""" +from setuptools import setup + +if __name__ == "__main__": + try: + setup(use_scm_version={"version_scheme": "no-guess-dev"}) + except: # noqa + print( + "\n\nAn error occurred while building the project, " + "please ensure you have the most updated version of setuptools, " + "setuptools_scm and wheel with:\n" + " pip install -U setuptools setuptools_scm wheel\n\n" + ) + raise diff --git a/src/aleph_vrf/__init__.py b/src/aleph_vrf/__init__.py new file mode 100644 index 0000000..9362aad --- /dev/null +++ b/src/aleph_vrf/__init__.py @@ -0,0 +1,16 @@ +import sys + +if sys.version_info[:2] >= (3, 8): + # TODO: Import directly (no need for conditional) when `python_requires = >= 3.8` + from importlib.metadata import PackageNotFoundError, version # pragma: no cover +else: + from importlib_metadata import PackageNotFoundError, version # pragma: no cover + +try: + # Change here if project is renamed and does not equal the package name + dist_name = "aleph-vrf" + __version__ = version(dist_name) +except PackageNotFoundError: # pragma: no cover + __version__ = "unknown" +finally: + del version, PackageNotFoundError diff --git a/src/aleph_vrf/coordinator/__init__.py b/src/aleph_vrf/coordinator/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/coordinator/main.py b/src/aleph_vrf/coordinator/main.py similarity index 90% rename from coordinator/main.py rename to src/aleph_vrf/coordinator/main.py index ecbf1a9..b0b30ae 100644 --- a/coordinator/main.py +++ b/src/aleph_vrf/coordinator/main.py @@ -12,8 +12,8 @@ from fastapi import FastAPI logger.debug("local imports") -from models import APIResponse -from vrf import generate_vrf +from aleph_vrf.models import APIResponse +from aleph_vrf.coordinator.vrf import generate_vrf logger.debug("imports done") diff --git a/vrf.py b/src/aleph_vrf/coordinator/vrf.py similarity index 85% rename from vrf.py rename to src/aleph_vrf/coordinator/vrf.py index 0c43b63..7a294cd 100644 --- a/vrf.py +++ b/src/aleph_vrf/coordinator/vrf.py @@ -1,14 +1,14 @@ import asyncio from hashlib import sha3_256 -from random import shuffle -from typing import Dict, List, Union +import random +from typing import Dict, List, Union, Any import aiohttp from aleph.sdk.chains.ethereum import ETHAccount from aleph.sdk.client import AuthenticatedAlephClient from aleph_message.status import MessageStatus -from models import ( +from aleph_vrf.models import ( CRNVRFResponse, Node, VRFRandomBytes, @@ -16,7 +16,7 @@ VRFResponse, VRFResponseHash, ) -from utils import bytes_to_int, generate_nonce, int_to_bytes, verify, xor_all +from aleph_vrf.utils import bytes_to_int, generate_nonce, int_to_bytes, verify, xor_all # TODO: Use environment settings API_HOST = "https://api2.aleph.im" @@ -37,41 +37,39 @@ async def post_node_vrf(session, url): return response["data"] -async def select_random_nodes(node_amount: int) -> List[Node]: - node_list: List[Node] = [] - +async def _get_corechannel_aggregate() -> Dict[str, Any]: async with aiohttp.ClientSession() as session: url = f"{API_HOST}/{API_PATH}" async with session.get(url) as response: if response.status != 200: raise ValueError(f"CRN list not available") - content = await response.json() + return await response.json() - if ( - not content["data"]["corechannel"] - or not content["data"]["corechannel"]["resource_nodes"] - ): - raise ValueError(f"Bad CRN list format") - resource_nodes = content["data"]["corechannel"]["resource_nodes"] +async def select_random_nodes(node_amount: int) -> List[Node]: + node_list: List[Node] = [] + + content = await _get_corechannel_aggregate() - for resource_node in resource_nodes: - node = Node( - hash=resource_node["hash"], - address=resource_node["address"], - score=resource_node["score"], - ) - node_list.append(node) + if ( + not content["data"]["corechannel"] + or not content["data"]["corechannel"]["resource_nodes"] + ): + raise ValueError(f"Bad CRN list format") - # Randomize node order - shuffle(node_list) + resource_nodes = content["data"]["corechannel"]["resource_nodes"] - random_nodes: List[Node] = [] - for node in range(node_amount): - random_nodes.append(node_list[node]) + for resource_node in resource_nodes: + node = Node( + hash=resource_node["hash"], + address=resource_node["address"], + score=resource_node["score"], + ) + node_list.append(node) - return random_nodes + # Randomize node order + return random.sample(node_list, min(node_amount, len(node_list))) async def generate_vrf(account: ETHAccount) -> VRFResponse: diff --git a/src/aleph_vrf/executor/__init__.py b/src/aleph_vrf/executor/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/generate-function/main.py b/src/aleph_vrf/executor/main.py similarity index 97% rename from generate-function/main.py rename to src/aleph_vrf/executor/main.py index 4a02d1f..4500966 100644 --- a/generate-function/main.py +++ b/src/aleph_vrf/executor/main.py @@ -15,14 +15,14 @@ from fastapi import FastAPI, Request logger.debug("local imports") -from models import ( +from aleph_vrf.models import ( APIResponse, VRFRandomBytes, VRFResponseHash, generate_request_from_message, generate_response_hash_from_message, ) -from utils import bytes_to_binary, bytes_to_int, generate +from aleph_vrf.utils import bytes_to_binary, bytes_to_int, generate logger.debug("imports done") diff --git a/models.py b/src/aleph_vrf/models.py similarity index 100% rename from models.py rename to src/aleph_vrf/models.py diff --git a/utils.py b/src/aleph_vrf/utils.py similarity index 100% rename from utils.py rename to src/aleph_vrf/utils.py diff --git a/tests/conftest.py b/tests/conftest.py new file mode 100644 index 0000000..9887b23 --- /dev/null +++ b/tests/conftest.py @@ -0,0 +1,10 @@ +""" + Dummy conftest.py for aleph_vrf. + + If you don't know what this is for, just leave it empty. + Read more about conftest.py under: + - https://docs.pytest.org/en/stable/fixture.html + - https://docs.pytest.org/en/stable/writing_plugins.html +""" + +# import pytest diff --git a/tests/coordinator/test_vrf.py b/tests/coordinator/test_vrf.py new file mode 100644 index 0000000..9b37343 --- /dev/null +++ b/tests/coordinator/test_vrf.py @@ -0,0 +1,128 @@ +from typing import Any, Dict + +import pytest + +from aleph_vrf.coordinator.vrf import select_random_nodes + + +@pytest.fixture +def fixture_nodes_aggregate() -> Dict[str, Any]: + return { + "address": "0xa1B3bb7d2332383D96b7796B908fB7f7F3c2Be10", + "data": { + "corechannel": { + "resource_nodes": [ + { + "hash": "fa5e90818bf50f358b642ed31361d83a0c6e94a1e07b055764d7e82789437f82", + "name": "tokenchain1", + "time": 1643038411.233, + "type": "compute", + "owner": "0x39Fbd6387Ec958FF9829385366AC2bD8DdF65Ef2", + "score": 0.9552090385081862, + "banner": "", + "locked": False, + "parent": "6c7578899ac475fbdc05c6a4711331c7590aa6b719f0c169941b99a10faf1136", + "reward": "0x39Fbd6387Ec958FF9829385366AC2bD8DdF65Ef2", + "status": "linked", + "address": "https://a-node-719754-y.tokenchain.network", + "manager": "", + "picture": "", + "authorized": "", + "description": "", + "performance": 0.9124243072477335, + "multiaddress": "", + "score_updated": True, + "decentralization": 0.9929203762386198, + "registration_url": "", + }, + { + "hash": "a2d2903fc58f3f031644959226cd17d1a2ba09e4a21e8ef11bf77913fd83899d", + "name": "Azateus", + "time": 1643047441.046, + "type": "compute", + "owner": "0x7057C12A7E270B9Db0E4c0d87c23Ba75fC5D82B1", + "score": 0.0, + "banner": "", + "locked": "", + "parent": None, + "reward": "0x7057C12A7E270B9Db0E4c0d87c23Ba75fC5D82B1", + "status": "waiting", + "address": "https://Aleph.ufa.ru", + "manager": "", + "picture": "", + "authorized": "", + "description": "", + "performance": 0.0, + "multiaddress": "", + "score_updated": True, + "decentralization": 0.9929203762386198, + "registration_url": "", + }, + { + "hash": "55697b7eefbcc1bdea4bed93b11932668025d5af82acdf17d350f02c9496245f", + "name": "ImAleph_0", + "time": 1643047955.517, + "type": "compute", + "owner": "0xB25C7ED25b854a036FE0D96a92059dE9C8391253", + "score": 0.9439967672476672, + "banner": "", + "locked": False, + "parent": "a07e5c9e324bfc73f6889202d3eb7b822c0f30490b5084e4ab9f3a49bbca0ad2", + "reward": "0xB25C7ED25b854a036FE0D96a92059dE9C8391253", + "status": "linked", + "address": "https://aleph0.serverrg.eu", + "manager": "", + "picture": "683b2e0a75dae42b5789da4d33bf959c1b04abe9ebeb3fe880bd839938fe5ac5", + "authorized": "", + "description": "", + "performance": 0.8911298965740464, + "multiaddress": "", + "score_updated": True, + "decentralization": 0.9235073688446255, + "registration_url": "", + }, + { + "hash": "a653f4f3b2166f20a6bf9b2be9bf14985eeab7525bc66a1fc968bb53761b00d1", + "name": "ImAleph_1", + "time": 1643048120.789, + "type": "compute", + "owner": "0xB25C7ED25b854a036FE0D96a92059dE9C8391253", + "score": 0.9421971134284096, + "banner": "", + "locked": False, + "parent": "9cbecc86d502a99e710e485266e37b9edab625245c406bfe93d9505a2550bcf8", + "reward": "0xB25C7ED25b854a036FE0D96a92059dE9C8391253", + "status": "linked", + "address": "https://aleph1.serverrg.eu", + "manager": "", + "picture": "683b2e0a75dae42b5789da4d33bf959c1b04abe9ebeb3fe880bd839938fe5ac5", + "authorized": "", + "description": "", + "performance": 0.8877354005528273, + "multiaddress": "", + "score_updated": True, + "decentralization": 0.9235073688446255, + "registration_url": "", + }, + ], + } + }, + } + + +@pytest.mark.asyncio +async def test_select_random_nodes(fixture_nodes_aggregate: Dict[str, Any], mocker): + network_fixture = mocker.patch( + "aleph_vrf.coordinator.vrf._get_corechannel_aggregate", + return_value=fixture_nodes_aggregate, + ) + + # Sanity check, avoid network accesses + assert network_fixture.called_once + + nodes = await select_random_nodes(3) + assert len(nodes) == 3 + + resource_nodes = fixture_nodes_aggregate["data"]["corechannel"]["resource_nodes"] + nodes = await select_random_nodes(len(resource_nodes) + 1) + assert len(nodes) == len(resource_nodes) diff --git a/tox.ini b/tox.ini new file mode 100644 index 0000000..69f8159 --- /dev/null +++ b/tox.ini @@ -0,0 +1,93 @@ +# Tox configuration file +# Read more under https://tox.wiki/ +# THIS SCRIPT IS SUPPOSED TO BE AN EXAMPLE. MODIFY IT ACCORDING TO YOUR NEEDS! + +[tox] +minversion = 3.24 +envlist = default +isolated_build = True + + +[testenv] +description = Invoke pytest to run automated tests +setenv = + TOXINIDIR = {toxinidir} +passenv = + HOME + SETUPTOOLS_* +extras = + testing +commands = + pytest {posargs} + + +# # To run `tox -e lint` you need to make sure you have a +# # `.pre-commit-config.yaml` file. See https://pre-commit.com +# [testenv:lint] +# description = Perform static analysis and style checks +# skip_install = True +# deps = pre-commit +# passenv = +# HOMEPATH +# PROGRAMDATA +# SETUPTOOLS_* +# commands = +# pre-commit run --all-files {posargs:--show-diff-on-failure} + + +[testenv:{build,clean}] +description = + build: Build the package in isolation according to PEP517, see https://github.com/pypa/build + clean: Remove old distribution files and temporary build artifacts (./build and ./dist) +# https://setuptools.pypa.io/en/stable/build_meta.html#how-to-use-it +skip_install = True +changedir = {toxinidir} +deps = + build: build[virtualenv] +passenv = + SETUPTOOLS_* +commands = + clean: python -c 'import shutil; [shutil.rmtree(p, True) for p in ("build", "dist", "docs/_build")]' + clean: python -c 'import pathlib, shutil; [shutil.rmtree(p, True) for p in pathlib.Path("src").glob("*.egg-info")]' + build: python -m build {posargs} +# By default, both `sdist` and `wheel` are built. If your sdist is too big or you don't want +# to make it available, consider running: `tox -e build -- --wheel` + + +[testenv:{docs,doctests,linkcheck}] +description = + docs: Invoke sphinx-build to build the docs + doctests: Invoke sphinx-build to run doctests + linkcheck: Check for broken links in the documentation +passenv = + SETUPTOOLS_* +setenv = + DOCSDIR = {toxinidir}/docs + BUILDDIR = {toxinidir}/docs/_build + docs: BUILD = html + doctests: BUILD = doctest + linkcheck: BUILD = linkcheck +deps = + -r {toxinidir}/docs/requirements.txt + # ^ requirements.txt shared with Read The Docs +commands = + sphinx-build --color -b {env:BUILD} -d "{env:BUILDDIR}/doctrees" "{env:DOCSDIR}" "{env:BUILDDIR}/{env:BUILD}" {posargs} + + +[testenv:publish] +description = + Publish the package you have been developing to a package index server. + By default, it uses testpypi. If you really want to publish your package + to be publicly accessible in PyPI, use the `-- --repository pypi` option. +skip_install = True +changedir = {toxinidir} +passenv = + # See: https://twine.readthedocs.io/en/latest/ + TWINE_USERNAME + TWINE_PASSWORD + TWINE_REPOSITORY + TWINE_REPOSITORY_URL +deps = twine +commands = + python -m twine check dist/* + python -m twine upload {posargs:--repository {env:TWINE_REPOSITORY:testpypi}} dist/*