ltcodecs 4.1.0__tar.gz → 4.2.1__tar.gz

ltcodecs-4.2.1/.gitlab-ci.yml

@@ -0,0 +1,197 @@
+workflow:
+  rules:
+    - when: always
+
+stages:
+  - build
+  - test
+  - combine_coverage
+  - deploy
+
+variables:
+  # Requires two additional vars, REGISTRY_URL and REGISTRY_REPO to be defined
+  # in CI/CD variables on gitlab
+
+  # dockerfile locations
+  ROS1_DOCKERFILE_PATH: "docker/tests.Dockerfile.ros1"
+  ROS2_DOCKERFILE_PATH: "docker/tests.Dockerfile.ros2"
+  DOCKERFILE_AUTODOCS_PATH: "docker/auto-docs.Dockerfile"
+
+  # version based configurations
+  ROS1_DISTRO: "noetic"
+  ROS2_DISTRO: "jazzy"
+  ROS1_BASE_IMAGE: "ros:${ROS1_DISTRO}-ros-base"
+  ROS2_BASE_IMAGE: "ros:${ROS2_DISTRO}-ros-base"
+
+  ROS_TEST_IMAGE_NAME: "ltcodec_tests"
+  ROS1_TAG: "ros1-test-pipeline-${CI_PIPELINE_ID}"
+  ROS2_TAG: "ros2-test-pipeline-${CI_PIPELINE_ID}"
+
+  DOCS_IMAGE_NAME: "ltcodec_auto_docs"
+  DOCS_TAG: "auto-doc-pipeline-${CI_PIPELINE_ID}"
+
+  ARMW_BRANCH: ""
+  PYACOMMS_BRANCH: ""
+  LTCODEC_BRANCH: ""
+
+  ROS_ACOMMS_BRANCH: "devel"
+  ROS_ACOMMS_NET_BRANCH: "devel"
+
+.build_image_template:
+  image: docker:stable
+  stage: build
+  tags:
+    - privileged
+  services:
+    - name: docker:dind
+  script:
+    - docker build --rm --build-arg ROS_DISTRO=${ROS_DISTRO} --build-arg BASE_IMAGE=${ROS_BASE_IMAGE} -t $ROS_TEST_IMAGE_NAME:${IMAGE_TAG} -f $ROS_DOCKERFILE_PATH .
+    - docker tag ${ROS_TEST_IMAGE_NAME}:${IMAGE_TAG} ${REGISTRY_URL}/${REGISTRY_REPO}/${ROS_TEST_IMAGE_NAME}:${IMAGE_TAG}
+    - docker push ${REGISTRY_URL}/${REGISTRY_REPO}/${ROS_TEST_IMAGE_NAME}:${IMAGE_TAG}
+
+build_ros_test_image_ros1:
+  extends: .build_image_template
+  variables:
+    IMAGE_TAG: "${ROS1_TAG}"
+    ROS_BASE_IMAGE: $ROS1_BASE_IMAGE
+    ROS_DOCKERFILE_PATH: $ROS1_DOCKERFILE_PATH
+
+build_ros_test_image_ros2:
+  extends: .build_image_template
+  variables:
+    IMAGE_TAG: "${ROS2_TAG}"
+    ROS_DOCKERFILE_PATH: $ROS2_DOCKERFILE_PATH
+    ROS_BASE_IMAGE: $ROS2_BASE_IMAGE
+
+build_auto_doc_image:
+  image: docker:stable
+  stage: build
+  tags:
+    - privileged
+  services:
+    - name: docker:dind
+  script:
+    - docker build --rm -t ${DOCS_IMAGE_NAME}:${DOCS_TAG} -f $DOCKERFILE_AUTODOCS_PATH .
+    - docker tag ${DOCS_IMAGE_NAME}:${DOCS_TAG} ${REGISTRY_URL}/${REGISTRY_REPO}/${DOCS_IMAGE_NAME}:${DOCS_TAG}
+    - docker push ${REGISTRY_URL}/${REGISTRY_REPO}/${DOCS_IMAGE_NAME}:${DOCS_TAG}
+
+trigger-ros_acomms-pipeline:
+  stage: test
+  trigger:
+    project: acomms/ros_acomms
+    branch: $ROS_ACOMMS_BRANCH
+    strategy: depend
+  variables:
+    LTCODEC_BRANCH: $LTCODEC_BRANCH
+    PYACOMMS_BRANCH: $PYACOMMS_BRANCH
+    ARMW_BRANCH: $ARMW_BRANCH
+  rules:
+    - if: '$CI_PIPELINE_SOURCE != "pipeline"'
+
+.test_template:
+  stage: test
+  script:
+    - pip install -r requirements.txt
+    - pip install .
+    - |
+      if [[ "$ARMW_BRANCH" != "" ]]; then
+          git clone -b "$ARMW_BRANCH" "https://gitlab-ci-token:$CI_JOB_TOKEN@git.whoi.edu/ros/armw.git" /armw && \
+          pip install /armw/.;
+      fi
+    - pytest --capture=no --junitxml=results.xml --cov=ltcodecs --cov-report=term --cov-report=xml --cov-report=html  tests/
+  artifacts:
+    paths:
+      - 'coverage.xml'
+      - 'htmlcov/'
+    reports:
+      junit: 'results.xml'
+      coverage_report:
+        coverage_format: cobertura
+        path: coverage.xml
+  coverage: '/TOTAL\s+\d+\s+\d+\s+(\d+)%/'
+
+.ros_version_selector:
+  variables:
+    ROS_DISTRO: $ROS1_DISTRO
+    ROS_WORKSPACE_OUTPUT_DIR: "devel"
+    IMAGE_FULL_NAME: "$REGISTRY_URL/$REGISTRY_REPO/$ROS_TEST_IMAGE_NAME:$ROS1_TAG"
+  rules:
+    - if: $ROS_VERSION == "ros2"
+      variables:
+        ROS_DISTRO: $ROS2_DISTRO
+        ROS_WORKSPACE_OUTPUT_DIR: "install"
+        IMAGE_FULL_NAME: "$REGISTRY_URL/$REGISTRY_REPO/$ROS_TEST_IMAGE_NAME:$ROS2_TAG"
+    - when: on_success
+  image: $IMAGE_FULL_NAME
+
+test:
+  extends:
+    - .test_template
+    - .ros_version_selector
+  parallel:
+    matrix:
+      - ROS_VERSION: [ros1, ros2]
+
+test_coverage:
+  image: "$REGISTRY_URL/$REGISTRY_REPO/$ROS_TEST_IMAGE_NAME:$ROS1_TAG"
+  stage: combine_coverage
+  script:
+    - ls *.coverage
+    - coverage combine --keep *.${ROS1_DISTRO}.coverage
+    - coverage xml
+    - coverage html
+    - coverage report --omit=*__init__.py
+  coverage: '/TOTAL\s+\d+\s+\d+\s+(\d+)%/'
+  artifacts:
+    paths:
+      - ".coverage"
+      - "htmlcov/"
+      - "coverage.xml"
+    reports:
+      coverage_report:
+        coverage_format: cobertura
+        path: coverage.xml
+  except:
+    - dev/autodocs
+        
+auto-docs:
+  image: "$REGISTRY_URL/$REGISTRY_REPO/$DOCS_IMAGE_NAME:$DOCS_TAG"
+  stage: deploy
+  script:
+    - pip install -r requirements.txt
+    - pip install .
+    - cd docs
+    - make latexpdf
+    - mv _build/latex/ltcodecs.pdf ..
+  artifacts:
+    paths:
+      - ltcodecs.pdf
+
+pages:
+  image: "$REGISTRY_URL/$REGISTRY_REPO/$DOCS_IMAGE_NAME:$DOCS_TAG"
+  stage: deploy
+  script:
+    - pip install -r requirements.txt
+    - pip install .
+    - cd docs
+    - sphinx-build -b html . ../public
+  artifacts:
+    paths:
+      - public
+  only:
+    - tags
+    - master
+
+pypi:
+  image: python
+  stage: deploy
+  script:
+    - pip install -r requirements.txt
+    - pip install build twine
+    - python -m build
+    - twine upload --username __token__ --password $PYPI_TOKEN dist/*
+  artifacts:
+    paths:
+      - dist/
+  only:
+    - tags

{ltcodecs-4.1.0 → ltcodecs-4.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ltcodecs
-Version: 4.1.0
+Version: 4.2.1
 Summary: LT Codecs: Lightweight codecs for use over low-throughput links
 Author: Woods Hole Oceanographic Institution, Acoustic Communications Group
 License: LGPL-3.0-or-later

ltcodecs-4.2.1/docker/tests.Dockerfile.ros1

@@ -0,0 +1,22 @@
+ARG BASE_IMAGE=ros:noetic-ros-base
+FROM ${BASE_IMAGE}
+
+# first lets ensure the GPG key is up to date
+RUN apt update; \
+    apt upgrade -y; \
+    apt install -y \
+        curl
+
+RUN rm /etc/apt/sources.list.d/ros1*
+RUN curl -s https://raw.githubusercontent.com/ros/rosdistro/master/ros.asc | sudo apt-key add -
+
+# Now lets get what else we need
+RUN apt update; \
+    apt upgrade -y; \
+    apt install -y \
+        python3-pip \
+        python3-venv \
+        curl \
+        git \
+        socat
+RUN pip install pytest pytest-cov

ltcodecs-4.2.1/docker/tests.Dockerfile.ros2

@@ -0,0 +1,10 @@
+ARG BASE_IMAGE=ros:jazzy-ros-base
+FROM ${BASE_IMAGE}
+
+RUN apt-get update && apt-get upgrade -y
+RUN apt install python3-pip python3-venv git -y
+
+RUN python3 -m venv /opt/venv
+ENV PATH="/opt/venv/bin:$PATH"
+
+RUN pip install -U pytest pytest-cov lark argcomplete numpy psutil

{ltcodecs-4.1.0 → ltcodecs-4.2.1}/src/ltcodecs/__init__.py

@@ -41,6 +41,7 @@ field_codec_classes = {
     "float32": IeeeFloat32Codec,
     "float64": IeeeFloat64Codec,
     "bool": BoolCodec,
+    "boolean": BoolCodec,
     "string": AsciiStringCodec,
     "ascii": AsciiStringCodec,
     "bytes": BytesCodec,

{ltcodecs-4.1.0 → ltcodecs-4.2.1}/src/ltcodecs.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ltcodecs
-Version: 4.1.0
+Version: 4.2.1
 Summary: LT Codecs: Lightweight codecs for use over low-throughput links
 Author: Woods Hole Oceanographic Institution, Acoustic Communications Group
 License: LGPL-3.0-or-later

{ltcodecs-4.1.0 → ltcodecs-4.2.1}/src/ltcodecs.egg-info/SOURCES.txt

@@ -6,8 +6,10 @@ README.md
 pyproject.toml
 requirements.txt
 .gitlab/merge_request_templates/Default.md
+docker/auto-docs.Dockerfile
+docker/tests.Dockerfile.ros1
+docker/tests.Dockerfile.ros2
 docs/Makefile
-docs/auto-docs.Dockerfile
 docs/conf.py
 docs/index.rst
 docs/ltcodecs.rst
@@ -43,5 +45,4 @@ src/ltcodecs.egg-info/requires.txt
 src/ltcodecs.egg-info/top_level.txt
 tests/__init__.py
 tests/string_msg_codec.yaml
-tests/test_codecs.py
-tests/tests.Dockerfile
+tests/test_codecs.py

{ltcodecs-4.1.0 → ltcodecs-4.2.1}/tests/test_codecs.py

@@ -9,8 +9,10 @@ import sys
 import pytest
 from bitstring import ConstBitStream
 
-import rospy
-from std_msgs.msg import String, ColorRGBA
+import armw
+
+String = armw.import_message("std_msgs", "String")
+ColorRGBA = armw.import_message("std_msgs", "ColorRGBA")
 
 import ltcodecs
 
@@ -337,7 +339,7 @@ class TestCodecs:
         # use a ColorRGBA message because it's part of std_msgs and has a field that we can cast as a boolean
         msg = ColorRGBA(r=1, g=1234.5678, b=3.14, a=4)
         message_dict = {}
-        for field in msg.__slots__:
+        for field in ['r', 'g', 'b', 'a']:
             message_dict[field] = getattr(msg, field)
 
         codec = ltcodecs.OptionalFieldCodec(target_fields={'g': {'codec': 'float32'}, 'b': {'codec': 'float32'}})
@@ -381,15 +383,14 @@ class TestCodecs:
     def test_ros_time_codec(self) -> None:
         """test functionality of the ros time field codec"""
 
-        input_time = rospy.Time.from_sec(time.time())
+        input_time = armw.Time().from_sec(time.time())
 
         codec = ltcodecs.rostime_codec.RosTimeCodec(precision=20)
         encoded_time = codec.encode(input_time)
 
         bit_stream = ConstBitStream(encoded_time[0])
 
-        decoded_time = codec.decode(bit_stream)
-
+        decoded_time = armw.get_time_object(codec.decode(bit_stream))
         assert decoded_time == input_time, "Decoded time does not match input time"
 
     def test_string_enum_codec(self) -> None:

ltcodecs-4.1.0/.gitlab-ci.yml

@@ -1,114 +0,0 @@
-build_test_image:
-  image: docker:stable
-  stage: build
-  tags:
-    - privileged
-  services:
-    - name: docker:dind
-  script:
-    - docker build --rm -t ltcodecs-tests:latest -f tests/tests.Dockerfile .
-
-build_auto-doc_image:
-  image: docker:stable
-  stage: build
-  tags:
-    - privileged
-  services:
-    - name: docker:dind
-  script:
-    - docker build --rm -t ltcodecs-docs:latest -f docs/auto-docs.Dockerfile .
-
-trigger-ros_acomms-master-pipeline:
-  trigger:
-    project: acomms/ros_acomms
-    branch: master
-    strategy: depend
-
-trigger-ros_acomms-devel-pipeline:
-  trigger:
-    project: acomms/ros_acomms
-    branch: devel
-    strategy: depend
-
-test:
-  image: ltcodecs-tests:latest
-  stage: test
-  script:
-    - source /ros_entrypoint.sh
-    - pip install -r requirements.txt
-    - pip install .
-    - pytest --capture=no --junitxml=results.xml --cov=ltcodecs --cov-report=term --cov-report=xml --cov-report=html  tests/
-  artifacts:
-    paths:
-      - 'coverage.xml'
-      - 'htmlcov/'
-    reports:
-      junit: 'results.xml'
-      coverage_report:
-        coverage_format: cobertura
-        path: coverage.xml
-  coverage: '/TOTAL\s+\d+\s+\d+\s+(\d+)%/'
-
-test-gitlab:
-  image: ltcodecs-tests:latest
-  stage: test
-  script:
-    - source /ros_entrypoint.sh
-    - pip install -r requirements.txt
-    - git clone https://gitlab-ci-token:$CI_JOB_TOKEN@git.whoi.edu/ros/armw.git ~/armw
-    - cd ~/armw && pip install .
-    - cd $CI_PROJECT_DIR
-    - pip install .
-    - pytest --capture=no --junitxml=results.xml --cov=ltcodecs --cov-report=term --cov-report=xml --cov-report=html  tests/
-  artifacts:
-    paths:
-      - 'coverage.xml'
-      - 'htmlcov/'
-    reports:
-      junit: 'results.xml'
-      coverage_report:
-        coverage_format: cobertura
-        path: coverage.xml
-  coverage: '/TOTAL\s+\d+\s+\d+\s+(\d+)%/'
-
-auto-docs:
-  image: ltcodecs-docs:latest
-  stage: deploy
-  script:
-    - pip install -r requirements.txt
-    - pip install .
-    - cd docs
-    - make latexpdf
-    - mv _build/latex/ltcodecs.pdf ..
-  artifacts:
-    paths:
-      - ltcodecs.pdf
-
-pages:
-  image: ltcodecs-docs:latest
-  stage: deploy
-  script:
-    - pip install -r requirements.txt
-    - pip install .
-    - cd docs
-    - sphinx-build -b html . ../public
-  artifacts:
-    paths:
-      - public
-  only:
-    - tags
-    - master
-
-pypi:
-  image: python
-  stage: deploy
-  script:
-    - pip install -r requirements.txt
-    - pip install build twine
-    - python -m build
-    - twine upload --username __token__ --password $PYPI_TOKEN dist/*
-  artifacts:
-    paths:
-      - dist/
-  only:
-    - tags

ltcodecs-4.1.0/tests/tests.Dockerfile

@@ -1,6 +0,0 @@
-FROM ros:noetic-ros-core
-
-# install ros package
-RUN apt-get update && apt-get upgrade -y
-RUN apt install python3-pip git ros-noetic-dynamic-reconfigure -y
-RUN pip install -U pytest pytest-cov