cyphalization of c_cpp (#15)

Author: thirtytwobits

.github/workflows/c_cpp.yml

@@ -0,0 +1,27 @@
+name: ghcr.io/opencyphal/c_cpp container build and publish.
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+defaults:
+  run:
+    working-directory: ./c_cpp
+
+jobs:
+
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: pull
+      run: docker pull ghcr.io/opencyphal/c_cpp:ubuntu-20.04
+    - name: build
+      run: docker build . --tag ghcr.io/opencyphal/c_cpp:ubuntu-20.04
+    - name: push
+      if: ${{ github.event_name != 'pull_request' }}
+      run: docker push ghcr.io/OpenCyphal/c_cpp:ubuntu-20.04

LICENSE

@@ -1,21 +1,21 @@
-MIT License
+The MIT License (MIT)
 
-Copyright (c) 2020 UAVCAN
+Copyright (c) 2014 Pavel Kirienko
+Copyright 2023 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 
-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:
+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.
+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.

README.md

@@ -1,4 +1,8 @@
-![UAVCAN](uavcan_logo.svg) UAVCAN Containerized Toolchains
+![OpenCyphal](opencyphal_logo.svg) OpenCyphal Containerized Toolchains
 ===================
 
-This repository contains the Dockerfiles, instructions, and some utilities for building containers to be used as common toolchains for the UAVCAN project. These containers are published to the [uavcan organization on Docker Hub](https://cloud.docker.com/u/uavcan) and are used by the build automation for UAVCAN projects. You can use these same containers to get consistent build results in your local development environment.
+This repository contains the Dockerfiles, instructions, and some utilities for building containers to be used as common
+toolchains for OpenCyphal projects. These containers are published to the
+[opencyphal organization on Github](https://github.com/orgs/OpenCyphal/packages) and are used by the build automation
+for OpenCyphal projects. You can use these same containers to get consistent build results in your local development
+environment.

c_cpp/Dockerfile

@@ -20,22 +20,45 @@ RUN /provision.sh
 # +---------------------------------------------------------------------------+
 # | INSTALL TOOLCHAINS
 # +---------------------------------------------------------------------------+
-ARG GCC_ARM_NONE_EABI_PLATFORM=x86_64-linux
-ARG GCC_ARM_NONE_EABI_VERSION=10-2020-q4-major
+
+# ARM: M-Cores, Bare Metal
+ARG GCC_ARM_NONE_EABI_PLATFORM=x86_64
+ARG GCC_ARM_NONE_EABI_VERSION=11.2-2022.02
+ARG GCC_ARM_NONE_EABI_TRIPLE=arm-none-eabi
+ARG GCC_ARM_NONE_EABI_BASENAME=gcc-arm-${GCC_ARM_NONE_EABI_VERSION}-${GCC_ARM_NONE_EABI_PLATFORM}-${GCC_ARM_NONE_EABI_TRIPLE}
+ARG GCC_ARM_NONE_EABI_REV=99a2bce6f4464be08eca01eda13e4e96
+ARG GCC_ARM_NONE_EABI_HASH=C371F8D384D7F8DC08BFE154352AA3AE
 
 WORKDIR /tmp
-ADD https://developer.arm.com/-/media/Files/downloads/gnu-rm/10-2020q4/gcc-arm-none-eabi-10-2020-q4-major-x86_64-linux.tar.bz2?revision=ca0cbf9c-9de2-491c-ac48-898b5bbc0443&la=en&hash=68760A8AE66026BCF99F05AC017A6A50C6FD832A /tmp/gcc-arm-none-eabi-${GCC_ARM_NONE_EABI_VERSION}-${GCC_ARM_NONE_EABI_PLATFORM}.tar.bz2
-RUN tar xjf gcc-arm-none-eabi-${GCC_ARM_NONE_EABI_VERSION}-${GCC_ARM_NONE_EABI_PLATFORM}.tar.bz2 -C /usr/share/
-RUN rm gcc-arm-none-eabi-${GCC_ARM_NONE_EABI_VERSION}-${GCC_ARM_NONE_EABI_PLATFORM}.tar.bz2
+ADD https://developer.arm.com/-/media/Files/downloads/gnu/${GCC_ARM_NONE_EABI_VERSION}/binrel/${GCC_ARM_NONE_EABI_BASENAME}.tar.xz?rev=${GCC_ARM_NONE_EABI_REV}&hash=${GCC_ARM_NONE_EABI_HASH} /tmp/${GCC_ARM_NONE_EABI_BASENAME}.tar.xz
+RUN tar xJf ${GCC_ARM_NONE_EABI_BASENAME}.tar.xz -C /usr/share/
+RUN rm ${GCC_ARM_NONE_EABI_BASENAME}.tar.xz
+
+ENV PATH="/usr/share/${GCC_ARM_NONE_EABI_BASENAME}/bin:${PATH}"
+
+RUN ${GCC_ARM_NONE_EABI_TRIPLE}-gcc --version
+
+# ARM: A-Cores, Linux
+ARG GCC_ARM_NONE_LINUX_PLATFORM=x86_64
+ARG GCC_ARM_NONE_LINUX_VERSION=11.2-2022.02
+ARG GCC_ARM_NONE_LINUX_TRIPLE=arm-none-linux-gnueabihf
+ARG GCC_ARM_NONE_LINUX_BASENAME=gcc-arm-${GCC_ARM_NONE_LINUX_VERSION}-${GCC_ARM_NONE_LINUX_PLATFORM}-${GCC_ARM_NONE_LINUX_TRIPLE}
+ARG GCC_ARM_NONE_LINUX_REV=ffc49e4af4cb4c298c2110a4d887716c
+ARG GCC_ARM_NONE_LINUX_HASH=13DC7A96AEA6FB1D479EB23B782E79EB
+
+ADD https://developer.arm.com/-/media/Files/downloads/gnu/${GCC_ARM_NONE_LINUX_VERSION}/binrel/${GCC_ARM_NONE_LINUX_BASENAME}.tar.xz?rev=${GCC_ARM_NONE_LINUX_REV}&hash=${GCC_ARM_NONE_LINUX_HASH} /tmp/${GCC_ARM_NONE_LINUX_BASENAME}.tar.xz
+RUN tar xJf ${GCC_ARM_NONE_LINUX_BASENAME}.tar.xz -C /usr/share/
+RUN rm ${GCC_ARM_NONE_LINUX_BASENAME}.tar.xz
 
-ENV PATH="/usr/share/gcc-arm-none-eabi-${GCC_ARM_NONE_EABI_VERSION}/bin:${PATH}"
+ENV PATH="/usr/share/${GCC_ARM_NONE_LINUX_BASENAME}/bin:${PATH}"
+
+RUN ${GCC_ARM_NONE_LINUX_TRIPLE}-gcc --version
 
-HEALTHCHECK CMD arm-none-eabi-gcc --version
 
 # +---------------------------------------------------------------------------+
 # | INSTALL SONAR SCANNER
 # +---------------------------------------------------------------------------+
-ENV SONAR_SCANNER_VERSION 4.2.0.1873
+ENV SONAR_SCANNER_VERSION 4.7.0.2747
 ENV SONAR_SCANNER_HOME=/sonar-scanner-${SONAR_SCANNER_VERSION}-linux
 ENV SONAR_SCANNER_OPTS="-server"
 
@@ -45,6 +68,11 @@ ENV PATH="${SONAR_SCANNER_HOME}/sonar-scanner-${SONAR_SCANNER_VERSION}-linux/bin
 COPY sonar_qube.sh /
 RUN /sonar_qube.sh
 
+# +---------------------------------------------------------------------------+
+# | INSTALL THE PATH FOR INTERATIVE SESSIONS
+# +---------------------------------------------------------------------------+
+RUN echo "export PATH=$PATH" >> ~/.bashrc
+
 # +---------------------------------------------------------------------------+
 # | INSTALL PYTHON AND NPM STUFF
 # +---------------------------------------------------------------------------+

c_cpp/README.md

@@ -1,41 +1,43 @@
 # C/C++ Toolchain Docker
 
-The `uavcan/c_cpp` docker image provides a consistent build and test environment
+The `opencyphal/c_cpp` docker image provides a consistent build and test environment
 for development, continuous-integration, and test automation of C and C++ based projects.
 
 ## Manual Build and Push
 
-These instructions are for maintainers with permissions to push to the [uavcan organization on Docker Hub](https://cloud.docker.com/u/uavcan).
+These instructions are for maintainers with permissions to push to the
+[OpenCyphal organization on Github](https://github.com/OpenCyphal/). Normally the container should be published by
+a github action but these instructions provide a way to manually update the container from any developer environment.
 
-```bash
-docker build .
-```
+First create a temporary (7-day expiration please) personal access token (classic) with write:packages and read:packages
+scope. See [this github help page](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)
+for instructions.
 
-```bash
-docker images
+Next, make sure you can login:
 
-REPOSITORY   TAG      IMAGE ID       CREATED              SIZE
-<none>       <none>   736647481ad3   About a minute ago   1GB
+```bash
+export FGP = (fine-grained permission for OpenCyphal organization)
+echo $FGP | docker login ghcr.io -u (github username) --password-stdin
 ```
 
+... now build:
+
 ```bash
-docker tag 736647481ad3 uavcan/c_cpp:ubuntu-20.04
-docker login --username=yourhubusername
-docker push uavcan/c_cpp:ubuntu-20.04
+docker build -t ghcr.io/opencyphal/c_cpp:ubuntu-20.04 .
 ```
 
-Use this pattern for tags:
+... and finally, push.
 
 ```bash
-uavcan/[toolchain]:[build environment]
+docker push ghcr.io/opencyphal/c_cpp:ubuntu-20.04
 ```
 
 ## Testing out the container
 
 To login to an interactive session do:
 
 ```bash
-docker run --rm -it -v ${PWD}:/repo uavcan/c_cpp:ubuntu-20.04
+docker run --rm -it -v ${PWD}:/repo ghcr.io/opencyphal/c_cpp:ubuntu-20.04
 ```
 
 ## Toolchain Documentation
@@ -52,8 +54,8 @@ Upload the results:
 
 ```bash
 sonar-scanner \
-  -Dsonar.organization=uavcan \
-  -Dsonar.projectKey=UAVCAN_myproject \
+  -Dsonar.organization=OpenCyphal \
+  -Dsonar.projectKey=OpenCyphal_myproject \
   -Dsonar.sources=. \
   -Dsonar.host.url=https://sonarcloud.io \
   -Dsonar.cfamily.build-wrapper-output=bw-output \
@@ -62,33 +64,13 @@ sonar-scanner \
 
 A [CMake example on github](https://github.com/SonarSource/sonarcloud_example_cpp-cmake-linux-otherci)
 
-## Travis CI
+## Github Actions
 
-You can use this in your .travis.yml like this:
+You can use this in your workflow yaml like this:
 
 ```none
-services:
-  - docker
-
-before_install:
-- docker pull uavcan/c_cpp:ubuntu-20.04
-
-script:
-- docker run --rm -v $TRAVIS_BUILD_DIR:/repo uavcan/c_cpp:ubuntu-20.04 /bin/sh -c mybuild_command
-
-```
-
-## BuildKite
-
-Example pipeline.yml:
-
-```yaml
-- label: ":github: my containerized build"
-    command: "my_build_command"
-    plugins:
-      - docker#v3.5.0:
-          workdir: /repo
-          image: "uavcan/c_cpp:ubuntu-20.04"
-          propagate-environment: true
-          mount-ssh-agent: true
+jobs:
+  my-job:
+    runs-on: ubuntu-latest
+    container: ghcr.io/opencyphal/c_cpp:ubuntu-20.04
 ```

c_cpp/provision.sh

@@ -32,11 +32,11 @@ export ENV LANGUAGE=en_US:en
 export ENV LC_ALL=en_US.UTF-8
 
 apt-get -y install software-properties-common
+add-apt-repository -y ppa:deadsnakes/ppa
 apt-get update
 apt-get -y install apt-utils
-apt-get -y install python3
+apt-get -y install python3.10
 apt-get -y install python3-pip
-apt-get -y install python3-venv
 apt-get -y install cmake
 apt-get -y install git
 apt-get -y install clang
@@ -56,7 +56,6 @@ apt-get -y install qemu
 apt-get -y install ninja-build
 apt-get -y install can-utils
 
-echo "export PATH=$PATH" >> ~/.bashrc
 echo "export LANG=en_US.UTF-8" >> ~/.bashrc
 echo "export LANGUAGE=en_US:en" >> ~/.bashrc
 echo "export LC_ALL=en_US.UTF-8" >> ~/.bashrc

opencyphal_logo.svg

@@ -12,7 +12,7 @@ ARG DEBIAN_FRONTEND=noninteractive
 RUN apt-get update && apt-get -y install apt-utils && apt-get -y install locales
 RUN locale-gen en_US.UTF-8
 
-ENV SONAR_SCANNER_VERSION 4.6.2.2472
+ENV SONAR_SCANNER_VERSION 4.8.0.2856
 ENV LANG=en_US.UTF-8
 ENV LANGUAGE=en_US:en
 ENV LC_ALL=en_US.UTF-8