diracx 0.0.1a2__tar.gz

diracx-0.0.1a2/.coveragerc

@@ -0,0 +1,15 @@
+[run]
+omit =
+    tests/*
+    src/diracx/client/*
+    */site-packages/diracx/client/*
+
+[report]
+exclude_lines =
+    # Have to re-enable the standard pragma
+    pragma: no cover
+
+    # Don't complain if tests don't hit defensive assertion code:
+    raise NotImplementedError
+
+    if TYPE_CHECKING:

diracx-0.0.1a2/.github/dependabot.yml

@@ -0,0 +1,7 @@
+version: 2
+updates:
+  # Maintain dependencies for GitHub Actions
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"

diracx-0.0.1a2/.github/workflows/containerised.yml

@@ -0,0 +1,33 @@
+name: containerised
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  docker:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v2
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v2
+      - name: Login to GitHub container registry
+        uses: docker/login-action@v2
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+      - name: Build and push
+        uses: docker/build-push-action@v4
+        with:
+          context: .
+          push: ${{ github.event_name == 'push' && github.repository == 'DIRACGrid/diracx' && github.ref_name == 'main' }}
+          tags: ghcr.io/diracgrid/diracx/server:latest
+          platforms: linux/amd64,linux/arm64

diracx-0.0.1a2/.github/workflows/deployment.yml

@@ -0,0 +1,135 @@
+name: Deployment
+
+on:
+  push:
+  pull_request:
+  workflow_dispatch:
+    inputs:
+      check-ci:
+        description: "Require the CI to have passed for this commit"
+        required: true
+        default: "yes"
+      version:
+        description: "Override the release version number (e.g. 8.0.0a5)"
+
+jobs:
+  deploy-pypi:
+    name: PyPI deployment
+    runs-on: "ubuntu-latest"
+    if: github.event_name != 'push' || github.repository == 'DIRACGrid/diracx'
+    permissions:
+      id-token: write  # IMPORTANT: this permission is mandatory for trusted publishing on pypi
+      actions: write
+      checks: write
+      contents: write
+      deployments: write
+      discussions: write
+      issues: write
+      packages: write
+      pages: write
+      pull-requests: write
+      repository-projects: write
+      security-events: write
+      statuses: write
+    defaults:
+      run:
+        # We need extglob for REFERENCE_BRANCH substitution
+        shell: bash -l -O extglob {0}
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          token: ${{ github.token }}
+      - run: |
+          git fetch --prune --unshallow
+          git config --global user.email "ci@diracgrid.org"
+          git config --global user.name "DIRACGrid CI"
+      - uses: actions/setup-python@v4
+        with:
+          python-version: '3.11'
+      - name: Installing dependencies
+        run: |
+          python -m pip install \
+              build \
+              python-dateutil \
+              pytz \
+              readme_renderer[md] \
+              requests \
+              setuptools_scm
+      - name: Validate README for PyPI
+        run: |
+          python -m readme_renderer README.md -o /tmp/README.html
+      - name: Prepare release notes
+        run: |
+          set -xeuo pipefail
+          IFS=$'\n\t'
+          # Needed for the advanced patter matching used in REFERENCE_BRANCH
+          PREV_VERSION=$(git describe --tags --abbrev=0)
+          # In case of manual trigger,
+          # GITHUB_REF is of the form refs/heads/main -> we want main
+          # In case of PR it is of the form refs/pull/59/merge -> we want pull/59/merge
+          REFERENCE_BRANCH=${GITHUB_REF##refs*(/heads)/}
+          echo "Making release notes for ${REFERENCE_BRANCH} since ${PREV_VERSION}"
+          (git log ${PREV_VERSION}...${REFERENCE_BRANCH} --oneline --no-merges --) > release.notes.new
+          cat release.notes.new
+      - name: Create tag if required
+        id: check-tag
+        run: |
+          set -xeuo pipefail
+          IFS=$'\n\t'
+          # Only do a real release for workflow_dispatch events
+          if [[ "${{ github.event_name }}" == "workflow_dispatch" ]]; then
+            echo "Will create a real release"
+            export NEW_VERSION="v${{ github.event.inputs.version }}"
+            if [[ "${NEW_VERSION}" == "v" ]]; then
+              # If version wasn't given as an input to the workflow, use setuptools_scm to guess while removing "dev" portion of the version number
+              NEW_VERSION=v$(python -m setuptools_scm | sed 's@Guessed Version @@g' | sed -E 's@(\.dev|\+g).+@@g')
+              export NEW_VERSION
+            fi
+            echo "Release will be named $NEW_VERSION"
+            # Validate the version
+            # Ensure the version doesn't look like a PEP-440 "dev release" (which might happen if the automatic version bump has issues)
+            python -c $'from packaging.version import Version; v = Version('"'$NEW_VERSION'"$')\nif v.is_devrelease:\n    raise ValueError(v)'
+            # Make sure we always only create pre-releases
+            python -c $'from packaging.version import Version; v = Version('"'$NEW_VERSION'"$')\nif not v.is_prerelease:\n    raise ValueError("integration should only be used for pre-releases")'
+            # Commit the release notes
+            mv release.notes release.notes.old
+            cat release.notes.old
+            (echo -e "[${NEW_VERSION}]" &&  cat release.notes.new release.notes.old) > release.notes
+            ###################3
+            # TODO: we should add the release notes somewhere at some point
+            # now we just don't do it because main branch is protected
+            # and we can't push directly from the CI
+            #git add release.notes
+            #git commit -m "docs: Add release notes for $NEW_VERSION"
+            # Stash is mandatory not to leave the repo dirty
+            git stash
+            ########################
+            git show
+            # Create the tag
+            git tag "$NEW_VERSION"
+            echo "create-release=true" >> $GITHUB_OUTPUT
+            echo "new-version=$NEW_VERSION" >> $GITHUB_OUTPUT
+          fi
+      - name: Build distributions
+        run: |
+          python -m build
+      - name: Make release on GitHub
+        if: steps.check-tag.outputs.create-release == 'true'
+        run: |
+          set -e
+          export NEW_VERSION=${{ steps.check-tag.outputs.new-version }}
+          REFERENCE_BRANCH=${GITHUB_REF##refs*(/heads)/}
+          echo "Pushing tagged release notes to ${REFERENCE_BRANCH}"
+          git push "origin" "${REFERENCE_BRANCH}"
+          echo "Making GitHub release for ${NEW_VERSION}"
+          .github/workflows/make_release.py \
+            --repo="${{ github.repository }}" \
+            --token="${{ secrets.GITHUB_TOKEN }}" \
+            --version="${NEW_VERSION}" \
+            --rev="$(git rev-parse HEAD)" \
+            --release-notes-fn="release.notes.new"
+      # Use trusted publisher for pypi
+      # https://docs.pypi.org/trusted-publishers/
+      - name: Publish package on PyPI
+        if: steps.check-tag.outputs.create-release == 'true'
+        uses: pypa/gh-action-pypi-publish@release/v1

diracx-0.0.1a2/.github/workflows/integration.yml

@@ -0,0 +1,53 @@
+name: Integration Tests
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+defaults:
+  run:
+    shell: bash -el {0}
+
+jobs:
+  dirac-integration-tests:
+    name: DIRAC Integration tests
+    if: github.repository == 'DIRACGrid/diracx'
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        dirac-branch:
+          - integration
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: '3.11'
+      - name: Prepare environment
+        run: |
+          pip install typer pyyaml gitpython packaging
+          git clone https://github.com/DIRACGrid/DIRAC.git -b "${{ matrix.dirac-branch }}" /tmp/DIRACRepo
+          # We need to cd in the directory for the integration_tests.py to work
+      - name: Prepare environment
+        run: cd /tmp/DIRACRepo && ./integration_tests.py prepare-environment "TEST_DIRACX=Yes"  --extra-module "diracx=${GITHUB_WORKSPACE}"
+      - name: Install server
+        run:  cd /tmp/DIRACRepo && ./integration_tests.py install-server
+      - name: Install client
+        run: cd /tmp/DIRACRepo && ./integration_tests.py install-client
+      - name: Server tests
+        run: cd /tmp/DIRACRepo && ./integration_tests.py test-server || touch server-tests-failed
+      - name: Client tests
+        run: cd /tmp/DIRACRepo && ./integration_tests.py test-client || touch client-tests-failed
+      - name: diracx logs
+        run: docker logs diracx
+      - name: Check test status
+        run: |
+          has_error=0
+          # TODO: set has_error=1 when we are ready to really run the tests
+          if [ -f server-tests-failed ]; then has_error=0; echo "Server tests failed"; fi
+          if [ -f client-tests-failed ]; then has_error=0; echo "Client tests failed"; fi
+          if [ ${has_error} = 1 ]; then exit 1; fi

diracx-0.0.1a2/.github/workflows/main.yml

@@ -0,0 +1,54 @@
+name: Basic Tests
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+
+defaults:
+  run:
+    shell: bash -el {0}
+
+jobs:
+  pytest:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+      - uses: mamba-org/setup-micromamba@v1
+        with:
+          environment-file: environment.yml
+          init-shell: bash
+          post-cleanup: 'all'
+      - name: Set up environment
+        run: |
+          pip install pytest-github-actions-annotate-failures
+          pip install git+https://github.com/DIRACGrid/DIRAC.git@integration
+          pip install .
+      - name: Run pytest
+        run: |
+          pytest . --cov-report=xml:coverage.xml --junitxml=report.xml
+      - name: Upload coverage report
+        uses: codecov/codecov-action@v3.1.4
+
+  mypy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+      - uses: mamba-org/setup-micromamba@v1
+        with:
+          environment-file: environment.yml
+          init-shell: bash
+          post-cleanup: 'all'
+      - name: Set up environment
+        run: |
+          pip install git+https://github.com/DIRACGrid/DIRAC.git@integration
+          pip install .
+      - name: Run mypy
+        run: |
+          mypy .

diracx-0.0.1a2/.github/workflows/make_release.py

@@ -0,0 +1,70 @@
+#!/usr/bin/env python
+import argparse
+from pathlib import Path
+
+import requests
+from packaging.version import Version
+
+
+def make_release(version, commit_hash, release_notes=""):
+    """Create a new GitHub release using the given data
+
+    This function always makes a pre-release first to ensure the "latest" release never corresponds
+    to one without artifacts uploaded. If the new version number is not a pre-release, as
+    determined by PEP-440, it is promoted to at full release after the uploads have completed
+    successfully.
+
+    :param str version: The version of the new release
+    :param str commit_hash: Git revision used for the release
+    :param str release_notes: Release notes
+    """
+    # Create a draft release
+    r = requests.post(
+        f"{api_root}/releases",
+        json={
+            "tag_name": version,
+            "target_commitish": commit_hash,
+            "body": release_notes,
+            "draft": True,
+            "prerelease": Version(version).is_prerelease,
+        },
+        headers=headers,
+    )
+    r.raise_for_status()
+    release_data = r.json()
+    print(f"Created draft release at: {release_data['html_url']}")
+
+    # Publish the release
+    r = requests.patch(
+        release_data["url"],
+        json={
+            "draft": False,
+        },
+        headers=headers,
+    )
+    r.raise_for_status()
+    release_data = r.json()
+    print(f"Published release at: {release_data['html_url']}")
+
+
+if __name__ == "__main__":
+    parser = argparse.ArgumentParser()
+    parser.add_argument("--token", required=True)
+    parser.add_argument("--repo", default="DIRACGrid/DIRAC")
+    parser.add_argument("--version", required=True)
+    parser.add_argument("--rev", required=True)
+    parser.add_argument("--release-notes-fn", required=True)
+    args = parser.parse_args()
+
+    token = args.token
+    headers = {
+        "Accept": "application/vnd.github.v3+json",
+        "Authorization": f"token {token}",
+    }
+    api_root = f"https://api.github.com/repos/{args.repo}"
+    release_notes = Path(args.release_notes_fn).read_text()
+
+    if not args.version.startswith("v"):
+        raise ValueError('For consistency versions must start with "v"')
+
+    make_release(args.version, args.rev, release_notes=release_notes)

diracx-0.0.1a2/.gitignore

@@ -0,0 +1,92 @@
+# Python
+*.py[cod]
+
+# Conda
+.conda
+
+# C extensions
+*.so
+var
+sdist
+lib
+lib64
+
+# Packages
+*.egg
+*.egg-info
+dist
+build
+eggs
+parts
+bin
+develop-eggs
+.installed.cfg
+
+# Translations
+*.mo
+
+# Mr Developer
+.mr.developer.cfg
+
+# Installer logs
+pip-log.txt
+
+# Unit test / coverage reports
+.coverage
+.tox
+.ruff_cache
+.mypy_cache
+
+# Eclipse
+.project
+.pydevproject
+.pyproject
+.settings
+.metadata
+
+#VSCode
+.vscode
+.env
+
+# Vim
+.*.sw[a-z]
+*.un~
+Session.vim
+*~
+
+# Intellij
+.idea/
+LHCbDIRAC.iml
+
+# MaxOSX files
+.DS_Store
+
+# test stuff
+.pytest_cache
+.cache
+__pycache__
+pytests.xml
+nosetests.xml
+coverage.xml
+Local_*
+.hypothesis
+*.gz
+htmlcov/
+*.xml.temp
+
+#remove in case we want a specific LHCb one
+.pylintrc
+
+# docs
+# this is auto generated
+docs/source/CodeDocumentation/
+docs/source/AdministratorGuide/Configuration/ExampleConfig.rst
+docs/source/AdministratorGuide/CommandReference
+docs/source/UserGuide/CommandReference
+docs/_build
+docs/source/_build
+
+
+# CMT junk
+/*/*/x86_64-*-*-*/
+*/*/cmt/Makefile

diracx-0.0.1a2/.gitlab-ci.yml

@@ -0,0 +1,45 @@
+.defaults:
+  only:
+    - merge_requests
+    - master@chaen/chrissquare-hack-a-ton
+
+.defaults-micromamba:
+  extends: .defaults
+  image: registry.cern.ch/docker.io/mambaorg/micromamba
+  before_script:
+    - micromamba env create --file environment.yml --name test-env
+    - eval "$(micromamba shell hook --shell=bash)"
+    - micromamba activate test-env
+    - pip install git+https://github.com/DIRACGrid/DIRAC.git@integration
+    - pip install .
+
+pre-commit:
+  extends: .defaults
+  image: registry.cern.ch/docker.io/library/python:3.11
+  variables:
+    PRE_COMMIT_HOME: ${CI_PROJECT_DIR}/.cache/pre-commit
+  cache:
+    paths:
+      - ${PRE_COMMIT_HOME}
+  before_script:
+    - pip install pre-commit
+  script:
+    - pre-commit run --all-files
+
+pytest:
+  extends: .defaults-micromamba
+  script:
+    - pytest . --cov-report=xml:coverage.xml --junitxml=report.xml
+  coverage: '/(?i)total.*? (100(?:\.0+)?\%|[1-9]?\d(?:\.\d+)?\%)$/'
+  artifacts:
+    when: always
+    reports:
+      junit: report.xml
+      coverage_report:
+        coverage_format: cobertura
+        path: coverage.xml
+
+mypy:
+  extends: .defaults-micromamba
+  script:
+    - mypy .

diracx-0.0.1a2/.pre-commit-config.yaml

@@ -0,0 +1,36 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+default_language_version:
+  python: python3
+
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.4.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: check-added-large-files
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: 'v0.0.287'
+    hooks:
+      - id: ruff
+        args: ["--fix"]
+
+  - repo: https://github.com/psf/black
+    rev: 23.7.0
+    hooks:
+      - id: black
+
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.5.1
+    hooks:
+      - id: mypy
+        additional_dependencies:
+          - pydantic==1.10.10
+          - sqlalchemy
+          - types-PyYAML
+          - types-cachetools
+          - types-requests
+        exclude: ^(src/diracx/client/|tests/|build)

diracx-0.0.1a2/Dockerfile

@@ -0,0 +1,41 @@
+#TODO: replace with micromamba
+FROM registry.cern.ch/docker.io/mambaorg/micromamba
+EXPOSE 8000
+
+# Create empty directory for the various volume to be mounted
+# and assign them to mambauser
+# This is needed for the DIRAC integration test, as docker-compose
+# isn't playing well with permissions and volumes
+USER root
+RUN mkdir /cs_store /signing-key && chown $MAMBA_USER:$MAMBA_USER /cs_store /signing-key
+USER $MAMBA_USER
+
+WORKDIR /code
+
+COPY --chown=$MAMBA_USER:$MAMBA_USER . /code/diracx
+
+# openssh is needed for ssh-keygen when we generate signing key
+RUN micromamba install --yes --file diracx/environment.yml --name=base git openssh &&  micromamba clean --all --yes
+
+ARG MAMBA_DOCKERFILE_ACTIVATE=1
+
+RUN  pip install ./diracx git+https://github.com/DIRACGrid/DIRAC.git@integration
+# Copying in ENTRYPOINT script
+COPY --chown=$MAMBA_USER:$MAMBA_USER dockerEntrypoint.sh /
+RUN chmod 755 /dockerEntrypoint.sh
+
+# Copying the mamba specific entrypoint with lower ulimit
+COPY --chown=$MAMBA_USER:$MAMBA_USER dockerMicroMambaEntrypoint.sh /
+RUN chmod 755 /dockerMicroMambaEntrypoint.sh
+
+ENTRYPOINT [ "/dockerEntrypoint.sh" ]
+
+
+
+
+# activate mamba for run commands
+# RUN pip install ./diracx
+
+# CMD ["uvicorn", "--factory", "diracx.routers:create_app", "--host", "0.0.0.0", "--port", "8000"]
+
+#  "--reload-dir", "/opt/conda/lib/python3.11/site-packages/diracx", "--reload"