Developing for Azure Linux easily (#6810)

Co-authored-by: Amaury Chamayou <[email protected]>
Co-authored-by: Amaury Chamayou <[email protected]>

.devcontainer/Dockerfile

@@ -0,0 +1,12 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the Apache 2.0 License.
+
+ARG BASE_IMAGE=mcr.microsoft.com/azurelinux/base/core:3.0
+FROM ${BASE_IMAGE}
+
+# Trust Microsoft-signed packages
+RUN gpg --import /etc/pki/rpm-gpg/MICROSOFT-RPM-GPG-KEY  \
+    && tdnf -y update
+
+# Basic dev deps, helps smoothly install VSCode server.
+RUN tdnf -y install build-essential

.devcontainer/devcontainer.json

@@ -1,31 +1,35 @@
 {
   "name": "CCF Development Environment",
-  "image": "ghcr.io/microsoft/ccf/ci/default:latest",
+  "build": {
+    "dockerfile": "Dockerfile",
+    "context": "."
+  },
   "runArgs": [],
-  "extensions": [
-    "eamodio.gitlens",
-    "esbenp.prettier-vscode",
-    "me-dutour-mathieu.vscode-github-actions",
-    "ms-azure-devops.azure-pipelines",
-    "ms-python.black-formatter",
-    "ms-python.python",
-    "ms-vscode.cpptools"
-  ],
-  "settings": {
-    "python.defaultInterpreterPath": "python3",
-    "[python]": {
-      "editor.defaultFormatter": "ms-python.black-formatter"
+  "customizations": {
+    "vscode": {
+      "extensions": [
+        "eamodio.gitlens",
+        "waderyan.gitblame",
+        "esbenp.prettier-vscode",
+        "github.vscode-github-actions",
+        "ms-python.black-formatter",
+        "ms-python.python",
+        "ms-vscode.cpptools",
+        "github.copilot"
+      ]
     },
-    "python.formatting.provider": "none",
-    "editor.defaultFormatter": "esbenp.prettier-vscode",
-    "editor.formatOnSave": true,
-    "editor.codeActionsOnSave": {
-      "source.fixAll": true
+    "settings": {
+      "python.defaultInterpreterPath": "python3",
+      "[python]": {
+        "editor.defaultFormatter": "ms-python.black-formatter"
+      },
+      "python.formatting.provider": "none",
+      "editor.defaultFormatter": "esbenp.prettier-vscode",
+      "editor.formatOnSave": true,
+      "editor.codeActionsOnSave": {
+        "source.fixAll": true
+      }
     }
   },
-  "features": {
-    "ghcr.io/devcontainers/features/docker-from-docker:1": {
-      "version": "latest"
-    }
-  }
+  "postCreateCommand": "./.devcontainer/post_create_setup.sh"
 }

.devcontainer/post_create_setup.sh

@@ -0,0 +1,10 @@
+#!/bin/bash
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the Apache 2.0 License.
+
+set -ex
+
+./scripts/setup-ci.sh
+./scripts/setup-dev.sh
+
+git config --global --add safe.directory /workspaces/CCF

.github/workflows/ci.yml

@@ -125,7 +125,7 @@ jobs:
         shell: bash
         run: |
           set -ex
-          ./scripts/install-azure-linux-deps.sh
+          ./scripts/setup-ci.sh
 
       - name: "Build Debug"
         run: |
@@ -147,6 +147,6 @@ jobs:
           export ASAN_SYMBOLIZER_PATH=$(realpath /usr/bin/llvm-symbolizer-15)
           # Unit tests
           ./tests.sh --output-on-failure -L unit -j$(nproc --all)
-          # All other acceptably fast tests, which are now supported on Mariner.
-          ./tests.sh --timeout 360 --output-on-failure -LE "benchmark|protocolstest|suite|unit|lts_compatibility"
+          # All other acceptably fast tests, which are now supported on Azure Linux.
+          ./tests.sh --timeout 360 --output-on-failure -LE "benchmark|suite|unit|lts"
         shell: bash

.github/workflows/long-test.yml

@@ -303,7 +303,7 @@ jobs:
         shell: bash
         run: |
           set -ex
-          ./scripts/install-azure-linux-deps.sh
+          ./scripts/setup-ci.sh
 
       - name: "Build Debug (Long Test)"
         run: |

.github/workflows/release.yml

@@ -105,10 +105,7 @@ jobs:
         shell: bash
         run: |
           set -ex
-          ./scripts/install-azure-linux-deps.sh
-          ./scripts/install-azure-linux-extended.sh
-          # For packaging and release tests
-          tdnf -y install rpm-build
+          ./scripts/setup-ci.sh
 
       - name: "Build Release ${{ matrix.platform.name }}"
         shell: bash

scripts/setup-ci.sh

@@ -0,0 +1,50 @@
+#!/bin/bash
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the Apache 2.0 License.
+
+set -ex
+H2SPEC_VERSION="v2.6.0"
+
+# Source control
+tdnf -y install  \
+    git  \
+    ca-certificates
+
+# To build CCF
+tdnf -y install  \
+    build-essential  \
+    clang  \
+    cmake  \
+    ninja-build  \
+    which  \
+    openssl-devel  \
+    libuv-devel  \
+    nghttp2-devel  \
+    curl-devel  \
+    libarrow-devel  \
+    parquet-libs-devel
+
+# To run standard tests
+tdnf -y install  \
+    lldb  \
+    expect  \
+    npm  \
+    jq
+
+# Extra-dependency for CDDL schema checker
+tdnf -y install rubygems
+gem install cddl
+
+# Release (extended) tests
+tdnf -y install procps
+
+# protocoltest
+tdnf install -y bind-utils
+curl -L --output h2spec_linux_amd64.tar.gz https://github.com/summerwind/h2spec/releases/download/$H2SPEC_VERSION/h2spec_linux_amd64.tar.gz
+tar -xvf h2spec_linux_amd64.tar.gz
+mkdir /opt/h2spec
+mv h2spec /opt/h2spec/h2spec
+rm h2spec_linux_amd64.tar.gz
+
+# For packaging
+tdnf -y install rpm-build

scripts/setup-dev.sh

@@ -0,0 +1,8 @@
+#!/bin/bash
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the Apache 2.0 License.
+
+set -ex
+
+tdnf -y install  \
+    vim