brock 0.1.0__tar.gz

brock-0.1.0/.brock.yml

@@ -0,0 +1,20 @@
+version: 0.1.0
+project: brock
+
+executors:
+  python:
+    type: docker
+    image: python:3.7
+    prepare:
+      - pip install -r requirements.txt
+      - pip install wheel pytest pytest-cov
+
+commands:
+  build:
+    steps:
+      - python setup.py bdist_wheel -d dist/
+      - python setup.py sdist -d dist/
+
+  test:
+    steps:
+      - pytest tests/

brock-0.1.0/.codeclimate.yml

@@ -0,0 +1,27 @@
+version: "2"
+plugins:
+  pep8:
+    enabled: true
+  fixme:
+    enabled: true
+    config:
+      strings:
+      - FIXME
+  radon:
+    enabled: true
+    config:
+      python_version: 3
+  duplication:
+    enabled: true
+    config:
+      languages:
+        python:
+          python_version: 3
+  sonar-python:
+    enabled: true
+    config:
+      minimum_severity: major
+  csslint:
+    enabled: true
+  rubocop:
+    enabled: false

brock-0.1.0/.gitignore

@@ -0,0 +1,16 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+**/*_cache
+
+# Distribution / packaging
+**/build/**
+!**/build/*.py
+*.egg
+*.eggs
+*.egg-info/
+MANIFEST
+
+# Coverage reports
+**/.coverage_html/**
+
+src/brock/__version__.py

brock-0.1.0/.gitlab-ci.yml

@@ -0,0 +1,188 @@
+stages:
+  - test
+  - build
+  - deploy
+  - release
+
+workflow:
+  rules:
+    # don't create a pipeline if its a commit pipeline, on a branch and that branch has open merge requests (bc we will get a MR build instead)
+    - if: $CI_PIPELINE_SOURCE == "push" && $CI_COMMIT_BRANCH && $CI_OPEN_MERGE_REQUESTS
+      when: never
+    - when: always
+
+variables:
+  PACKAGE_REGISTRY: "${CI_API_V4_URL}/projects/${CI_PROJECT_ID}/packages/generic/brock"
+
+pre-commit:
+  stage: .pre
+  image:
+    name: registry.benderrobotics.com/br/toolchains/pre-commit:2.17.0
+  tags:
+    - docker
+  script:
+    - pre-commit run --all-files --show-diff-on-failure
+
+.code-quality:
+  stage: test
+  tags:
+    - docker
+  image: docker:stable
+  allow_failure: true
+  variables:
+    CI_DEBUG_TRACE: "false"
+    REPORT_FORMAT: "json"
+  script:
+    - echo $REPORT_FORMAT
+    - CONTAINER_ID=$(docker ps -q -f "label=com.gitlab.gitlab-runner.job.id=${CI_JOB_ID}")
+    - VOLUME_PATH=$(docker inspect $CONTAINER_ID --format '{{ range .Mounts }}{{ if eq .Destination "/builds" }}{{ .Source }}{{ end }}{{ end }}')
+    - VOLUME_CODE_PATH="${VOLUME_PATH}/${CI_PROJECT_DIR#$CI_BUILDS_DIR}"
+    - docker run
+        --rm
+        --env SOURCE_CODE=$VOLUME_CODE_PATH
+        --env REPORT_FORMAT=$REPORT_FORMAT
+        --env CODECLIMATE_DEV=1
+        --volume /var/run/docker.sock:/var/run/docker.sock
+        --volume $VOLUME_CODE_PATH:/code
+        registry.gitlab.com/gitlab-org/ci-cd/codequality:latest /code
+  artifacts:
+    expire_in: 1 week
+  dependencies: []
+
+code-quality-json:
+  extends: .code-quality
+  artifacts:
+    reports:
+      codequality: gl-code-quality-report.json
+    paths: [gl-code-quality-report.json]
+
+code-quality-html:
+  extends: .code-quality
+  variables:
+    REPORT_FORMAT: "html"
+  artifacts:
+    paths: [gl-code-quality-report.html]
+
+test-unit:
+  stage: test
+  image: python:3.9
+  tags:
+    - docker
+  script:
+    - pip install virtualenv
+    - virtualenv venv
+    - source venv/bin/activate
+    - pip install -e ./[test]
+    - pytest tests/
+    - sed -i 's|<source>.*</source>|<source></source>|g;s|filename="|filename="src/brock/|g' coverage.xml
+  allow_failure: true
+  artifacts:
+    reports:
+      coverage_report:
+        coverage_format: cobertura
+        path: coverage.xml
+
+build:
+  stage: build
+  image: python:3.9
+  tags:
+    - docker
+  artifacts:
+    paths:
+      - dist
+    expire_in: 30 days
+    reports:
+      dotenv: variables.env
+  before_script:
+    - pip install -U setuptools setuptools_scm build wheel
+  script:
+    - VERSION=$(python -c "import build.util; print(build.util.project_wheel_metadata('.').get('Version'))")
+    - python -m build --sdist --wheel --outdir $CI_PROJECT_DIR/dist .
+    - PACKAGE_NAME=$(cd dist && ls *.whl | head -1)
+    - ARCHIVE_NAME=$(cd dist && ls *.tar.gz | head -1)
+    - echo "PACKAGE_NAME=${PACKAGE_NAME}" >> variables.env
+    - echo "ARCHIVE_NAME=${ARCHIVE_NAME}" >> variables.env
+    - echo "VERSION=${VERSION}" >> variables.env
+
+
+build-release-changelog:
+  image: python:3.9
+  stage: build
+  tags:
+    - docker
+  rules:
+    - if: $CI_COMMIT_TAG =~ /^v[0-9]+\.[0-9]+\.[0-9]+$/
+  before_script:
+    - pip install -i https://pypi.benderrobotics.com setuptools setuptools_scm gitlab_tools build
+  script:
+    - VERSION=$(python -c "import build.util; print(build.util.project_wheel_metadata('.').get('Version'))")
+    - gitlab-tools tag-changelog -t $API_TOKEN -u $CI_SERVER_URL -p $CI_PROJECT_PATH -o changes.md
+  artifacts:
+    paths:
+      - "changes.md"
+    expire_in: 1 days
+
+deploy-wheel:
+  stage: deploy
+  needs:
+    - build
+  tags:
+    - docker
+  image: chartedcode/alpine-sftp-client
+  before_script:
+    - echo "$PYPI_KEY" | tr -d '\r' > ./ssh_key
+    - chmod 600 ./ssh_key
+  script:
+    - TAG_VERSION=${CI_COMMIT_TAG#"v"}
+    - test $VERSION = $TAG_VERSION
+    - |
+      sftp -i ./ssh_key -oStrictHostKeyChecking=no $PYPI_USER@$PYPI_HOST:/brock/ << EOF
+        put dist/*
+        quit
+      EOF
+  rules:
+    - if: $CI_COMMIT_TAG =~ /^v[0-9]+\.[0-9]+\.[0-9]+.*$/ && $PYPI_USER && $PYPI_KEY
+
+deploy-pypi:
+  stage: deploy
+  needs:
+    - build
+  tags:
+    - docker
+  image: python:3.9
+  before_script:
+    - pip install twine
+  script:
+    - twine upload --repository-url $PYPI_INDEX dist/*
+
+
+deploy-release:
+  stage: deploy
+  needs: [build]
+  image: curlimages/curl:latest
+  tags:
+    - docker
+  script:
+    - TAG_VERSION=${CI_COMMIT_TAG#"v"}
+    - test $VERSION = $TAG_VERSION
+    - 'curl --header "JOB-TOKEN: $CI_JOB_TOKEN" --upload-file "dist/${PACKAGE_NAME}" "${PACKAGE_REGISTRY}/${VERSION}/${PACKAGE_NAME}"'
+    - 'curl --header "JOB-TOKEN: $CI_JOB_TOKEN" --upload-file "dist/${ARCHIVE_NAME}" "${PACKAGE_REGISTRY}/${VERSION}/${ARCHIVE_NAME}"'
+  rules:
+    - if: $CI_COMMIT_TAG =~ /^v[0-9]+\.[0-9]+\.[0-9]+$/
+
+release:
+  stage: release
+  image: registry.gitlab.com/gitlab-org/release-cli:latest
+  tags:
+    - docker
+  script:
+    - TAG_VERSION=${CI_COMMIT_TAG#"v"}
+    - test $VERSION = $TAG_VERSION
+    - DESCRIPTION=$(cat changes.md)
+    - |
+      release-cli create --name "Release of Brock $CI_COMMIT_TAG" --tag-name $CI_COMMIT_TAG --milestone "$CI_COMMIT_TAG" \
+        --description "$DESCRIPTION" \
+        --assets-link "{\"name\":\"${PACKAGE_NAME}\",\"url\":\"${PACKAGE_REGISTRY}/${VERSION}/${PACKAGE_NAME}\"}" \
+        --assets-link "{\"name\":\"${ARCHIVE_NAME}\",\"url\":\"${PACKAGE_REGISTRY}/${VERSION}/${ARCHIVE_NAME}\"}"
+  rules:
+    - if: $CI_COMMIT_TAG =~ /^v[0-9]+\.[0-9]+\.[0-9]+$/

brock-0.1.0/.pre-commit-config.yaml

@@ -0,0 +1,32 @@
+# File introduces automated checks triggered on git events
+# to enable run `pip install pre-commit yapf && pre-commit install`
+
+repos:
+  - repo: local
+    hooks:
+      - id: yapf
+        name: yapf
+        language: python
+        entry: yapf
+        args: [-i]
+        types: [python]
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v3.2.0
+    hooks:
+      - id: trailing-whitespace
+      - id: check-docstring-first
+      - id: check-json
+      - id: check-yaml
+      - id: requirements-txt-fixer
+      - id: double-quote-string-fixer
+      - id: end-of-file-fixer
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v0.931
+    hooks:
+      - id: mypy
+        args: [--ignore-missing-imports]
+        additional_dependencies: ["types-PyYAML==6.0.1"]
+        exclude: 'tests'
+  - repo: meta
+    hooks:
+      - id: check-useless-excludes

brock-0.1.0/.style.yapf

@@ -0,0 +1,7 @@
+[style]
+based_on_style=google
+column_limit=120
+split_before_logical_operator=True
+continuation_align_style=SPACE
+dedent_closing_brackets=True
+coalesce_brackets=True

brock-0.1.0/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2021 The Python Packaging Authority
+
+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.

brock-0.1.0/PKG-INFO

@@ -0,0 +1,261 @@
+Metadata-Version: 2.1
+Name: brock
+Version: 0.1.0
+Summary: Brock
+Author-email: "Bender Robotics s.r.o" <opensource@benderrobotics.com>
+License: Copyright (c) 2021 The Python Packaging Authority
+        
+        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.
+        
+Project-URL: Homepage, https://www.benderrobotics.com
+Project-URL: Repository, https://github.com/BenderRobotics/brock.git
+Project-URL: Issues, https://github.com/BenderRobotics/brock/issues
+Keywords: build,docker,toolchain
+Classifier: Intended Audience :: Developers
+Classifier: Development Status :: 4 - Beta
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Topic :: Software Development
+Classifier: Topic :: Software Development :: Build Tools
+Classifier: Topic :: Software Development :: Embedded Systems
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX
+Classifier: Operating System :: Unix
+Classifier: Operating System :: MacOS
+Classifier: License :: OSI Approved :: MIT License
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: markupsafe==2.0.1
+Requires-Dist: colorama>=0.4.1
+Requires-Dist: click>=7.1.2
+Requires-Dist: hiyapyco
+Requires-Dist: schema
+Requires-Dist: setuptools_scm>=7.0.0
+Requires-Dist: munch
+Requires-Dist: fabric
+Requires-Dist: docker>=6.0.1
+Requires-Dist: sentry-sdk~=1.39
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: pytest-cov; extra == "test"
+
+# Bender Robotics command management system
+Brock is a Python-based automation tool for launching commands in various
+executors like Docker or remote systems. It was designed mainly for building
+and testing automation of embedded software in Docker-based executors.
+
+
+## Installation
+
+### Prerequisities
+Brock needs Docker to be installed and configured properly:
+1. Install [Windows Subsystem for Linux 2](https://docs.microsoft.com/cs-cz/windows/wsl/install-win10).
+2. Download and install [Docker Desktop](https://www.docker.com/products/docker-desktop).
+3. Switch to Windows containers if the executor is Windows-based - click Docker
+   Desktop icon and select Switch to Windows containers... (requires Windows Pro
+   or Enterprise), or turn experimental features on - open Docker Desktop, go to
+   Settings -> Docker Engine, set `"experimental": true` (allows to use Linux
+   and Windows containers simultaneously).
+
+### Brock
+You can install Brock from BR's pypi, download wheel from release page or
+build it yourself - see [Contributing](#Contributing)...
+```shell
+$ pip install brock
+```
+
+## Usage
+Brock scans all directories from drive root to current directory and looks
+for `.brock.yml` config files. The format of the files is described in
+[example_brock.yml](example_brock.yml).
+
+The configuration files are merged together, the highest priority config file
+is the one in the current directory. Individual config files don't have to be
+complete, however, the merged configuration must contain all required
+parameters.
+
+The lowest priority config file determines the base directory which will be
+used as a working directory for the executor (e.g. mounted to docker, mounted
+over SSH). The commands should not access files outside this directory.
+
+The list of all available commands is provided by `brock --help`, let's assume
+a command `test` was defined in the `.brock.yml`, you can run it like this:
+```shell
+$ brock test
+>> Executor not running -> starting
+>> Pulling image python:3.9
+./debug/test -s
+
+Unity test run 1 of 1
+
+-----------------------
+483 Tests 0 Failures 0 Ignored
+OK
+```
+
+If the required executor is not running, it is started automatically when
+executing a command. It stays running until it is explicitly stopped by
+`brock --stop`. The executors can also be restarted (e.g. to fetch changes in
+the brock configuration) by `brock --restart`. The current state of the
+executors is printed by `brock --status`.
+
+The docker image can be pulled again or rebuilt (if using Dockerfile) using
+`brock --update`.
+
+If needed, you can launch a custom command directly in the executor by
+`brock exec`:
+```shell
+$ brock exec @python 'python --version'
+Python 3.9.10
+```
+
+Optionally, quotes or double-dash (`--`) can be used to avoid brock collecting
+options destined to the command launched by executor:
+```shell
+$ brock exec @python "python --version"
+Python 3.9.10
+$ brock exec @python -- python --version
+Python 3.9.10
+
+If using a custom Docker registry, do not forget to login into the registry
+before using `brock` - use full registry path including image name and tag:
+```shell
+$ docker login $IMAGE_REGISTRY
+Username: $USER_NAME
+Password:
+Login Succeeded
+```
+
+If using Docker executor, you can launch a shell using `brock shell` (default
+executor will be used if ommited):
+```shell
+$ brock shell @gcc
+root@6bf119cb7b6a:/host# exit
+exit
+```
+
+Brock sets the following predefined environmental variables:
+- `BROCK_HOST_PATH` - absolute path to current directory on host
+- `BROCK_HOST_PROJECT_PATH` - absolute path to project root on host
+- `BROCK_RELATIVE_PATH` - relative path from project root to current directory
+
+Additional variables can be set using the config option `env` for each executor.
+
+#### Options
+Brock offers the possibility of options in commands.
+Configuration of options in .brock.yaml (see example_brock.yml)
+
+opt-name:
+- flag: str | None -> option is a flag e.g. `brock build --verbose`
+
+- argument: str | None  -> option is an argument e.g. `brock build something`,
+can be * then an unlimited number of arguments is accepted
+
+- default: any | None -> any value
+
+- choice: list[str] -> list of acceptable values, brock checks input is in choice and also displays it in help
+
+- variable: str | None -> optional custom name of the variable inside the session, to avoid any conflicts with built-in variables
+
+- help: str | None
+
+
+### Isolation types
+The Brock can detect Windows version and the version of the Windows Docker
+image, the needed isolation mode is determined automatically - if possible,
+the image is started in `process` isolation, `hyperv` is used otherwise.
+
+### Volume synchronization
+To achieve satisfactory performance when using Linux containers on Windows
+(or macOS), the project folder needs to be mounted more efficiently. For this
+purpose, two volume synchronization mechanisms are available: Rsync or Mutagen.
+
+#### Rsync
+An additional container with Rsync is started - the project folder is mounted to
+this container together with a named volume (that will reside inside the Linux
+host) and these folders are then being synced using Rsync. To turn this feature
+on, use the `sync` option in the config file.
+
+Optionally, specific files/folders can be excluded from sync using
+configuration option `exclude` under `sync` section.
+
+#### Mutagen
+Another option to synchronize volumes on macOS or Windows is to use
+[Mutagen Extension](https://mutagen.io/documentation/docker-desktop-extension)
+for Docker Desktop. Before use, it must be installed first:
+```shell
+docker extension install mutagenio/docker-desktop-extension:latest
+```
+Then, a cache must be created for each path which should be synchronized. Go to
+Docker Desktop -> Extensions -> Mutagen, click Create Cache and enter the
+project root path. Finally, configure the executor to use Mutagen
+volume synchronization (see `example_brock.yml`).
+
+### Devices in Docker executor
+The docker can use the system devices if passed correctly, however this only
+works when running a native container - e.g. a Windows container with the same
+system version as the Windows host, or a Linux container under a Linux host.
+Check the `devices` section of the config file.
+
+
+## Build
+Please first apply all steps in [contributing section](#Contributing).
+
+After that you can call build scripts:
+```shell
+$ python build/build.py  # builds the package
+```
+You can find build artifacts in the newly created dist folder.
+
+## Contributing
+Here is a short guide to ease you up contributing.
+
+Start by installing virtual environment package
+```shell
+$ pip install virtualenv
+```
+Then create your own virtual environment
+```shell
+$ virtualenv venv
+```
+Now you should see venv folder in the project structure.
+Activate virtual environment
+```shell
+$ source venv/bin/activate  # on linux
+$ venv\Scripts\activate.bat # on windows
+```
+After that you should see (venv) as prefix to your command line cursor.
+Note you need to repeat activation every time you close the terminal.
+
+To install the package in development mode call:
+```shell
+$ pip install -e .
+```
+Now you can call Brock directly from the command line and all changes to the
+source code are instantly applied.