Merge branch 'basic-macos-ci' into 'main'

Draft: WIP add basic macOS CI jobs

See merge request gstreamer/gstreamer-rs!1425

.gitlab-ci.yml

@@ -59,526 +59,74 @@ variables:
     0.22=0.22
 
 stages:
-  - "trigger"
-  - "container-base"
-  - "container-final"
-  - "lint"
   - "test"
-  - "extras"
-  - "deploy"
 
-# This is an empty job that is used to trigger the pipeline.
-trigger:
-  image: alpine:latest
-  stage: 'trigger'
-  variables:
-    GIT_STRATEGY: none
-  tags: [ 'placeholder-job' ]
-  script:
-    - echo "Trigger job done, now running the pipeline."
-  rules:
-    - if: $CI_PIPELINE_SOURCE == "schedule"
-    # If the MR is assigned to the Merge bot, trigger the pipeline automatically
-    - if: '$CI_MERGE_REQUEST_ASSIGNEES == "gstreamer-merge-bot"'
-    # Require explicit action to trigger tests post merge
-    - if: '$CI_PROJECT_NAMESPACE == "gstreamer" && $CI_COMMIT_BRANCH == "main"'
-      when: 'manual'
-    # When the assignee isn't the merge bot, require an explicit action to trigger the pipeline
-    # to avoid wasting CI resources
-    - if: '$CI_MERGE_REQUEST_ASSIGNEES != "gstreamer-merge-bot"'
-      when: 'manual'
-      allow_failure: false
+.macos:arm64:
+  image: "registry.freedesktop.org/gstreamer/cerbero/macos-arm64/14-sonoma:2023-10-25.2"
+  tags:
+    - 'gst-mac-arm'
 
-.debian:12:
-  needs: []
-  variables:
-    FDO_DISTRIBUTION_VERSION: 'bookworm-slim'
-  before_script:
-    - source ./ci/env.sh
-    - mkdir .cargo && echo -e "[net]\ngit-fetch-with-cli = true" > .cargo/config
-
-.debian:12-base:
-  extends: .debian:12
-  variables:
-    FDO_DISTRIBUTION_TAG: 'base-$GST_RS_IMG_TAG'
-
-.debian:12-stable:
-  extends: .debian:12
-  variables:
-    RUST_IMAGE_FULL: "1"
-    FDO_DISTRIBUTION_TAG: '$GST_RS_STABLE-$GST_RS_IMG_TAG'
-    FDO_DISTRIBUTION_EXEC: 'bash ci/install-rust.sh $GST_RS_STABLE $RUST_IMAGE_FULL'
-
-.debian:12-msrv:
-  extends: .debian:12
-  variables:
-    FDO_DISTRIBUTION_TAG: '$GST_RS_MSRV-$GST_RS_IMG_TAG'
-    FDO_DISTRIBUTION_EXEC: 'bash ci/install-rust.sh $GST_RS_MSRV $RUST_IMAGE_FULL'
-
-.debian:12-nightly:
-  extends: .debian:12
-  variables:
-    FDO_DISTRIBUTION_TAG: 'nightly-$GST_RS_IMG_TAG'
-    FDO_DISTRIBUTION_EXEC: 'bash ci/install-rust.sh nightly $RUST_IMAGE_FULL'
-
-.build-base-image:
-  extends:
-  - .fdo.container-build@debian
-  stage: container-base
-  variables:
-    FDO_DISTRIBUTION_PACKAGES: >-
-      build-essential curl python3-setuptools libglib2.0-dev libxml2-dev
-      libdrm-dev libegl1-mesa-dev libgl1-mesa-dev libgbm-dev libgles2-mesa-dev
-      libgl1-mesa-dri libegl-dev libgl1-mesa-glx libwayland-egl1-mesa xz-utils
-      libssl-dev git wget ca-certificates ninja-build python3-pip flex bison
-      libglib2.0-dev libx11-dev libx11-xcb-dev libsoup2.4-dev libvorbis-dev
-      libogg-dev libtheora-dev libmatroska-dev libvpx-dev libopus-dev
-      libgraphene-1.0-dev libjpeg-dev libwayland-dev wayland-protocols
-      python3-gi libavcodec-dev libavformat-dev libavutil-dev libavfilter-dev
-      libswscale-dev yasm libx264-dev libfontconfig-dev libfreetype-dev
-      libxkbcommon-dev libxi-dev libxcb-render0-dev libxcb-shm0-dev
-      libxcb1-dev libxext-dev libxrender-dev libxrandr-dev libxcursor-dev
-      libxdamage-dev libxfixes-dev libxinerama-dev libgudev-1.0-dev
-      libpango1.0-dev libcairo2-dev libjson-glib-dev libgdk-pixbuf-2.0-dev
-      libtiff-dev libpng-dev libjpeg-dev libepoxy-dev libsass-dev sassc
-      libcsound64-dev llvm clang nasm libsodium-dev libwebp-dev
-      libflac-dev
-    FDO_DISTRIBUTION_EXEC: >-
-      bash ci/install-gst.sh &&
-      bash ci/install-dav1d.sh &&
-      pip3 install --break-system-packages git+http://gitlab.freedesktop.org/freedesktop/ci-templates &&
-      pip3 install --break-system-packages tomli
-
-.build-final-image:
-  extends:
-  - .fdo.container-build@debian
-  stage: container-final
-  variables:
-    FDO_BASE_IMAGE: '$CI_REGISTRY_IMAGE/debian/bookworm-slim:base-$GST_RS_IMG_TAG'
-
-build-base:
-  extends:
-    - .build-base-image
-    - .debian:12-base
-
-build-stable:
-  needs: ["build-base"]
-  extends:
-    - .build-final-image
-    - .debian:12-stable
-
-build-msrv:
-  needs: ["build-base"]
-  extends:
-    - .build-final-image
-    - .debian:12-msrv
-
-build-nightly:
-  needs: ["build-base"]
-  extends:
-    - .build-final-image
-    - .debian:12-nightly
-
-update-nightly:
-  extends: build-nightly
-  rules:
-    - if: $UPDATE_NIGHTLY == "1"
-  variables:
-      FDO_FORCE_REBUILD: 1
-
-.dist-debian-container:
-  extends:
-  - .fdo.distribution-image@debian
+.macos:arm64-stable:
+  extends: .macos:arm64
   after_script:
     - rm -rf target
 
-.img-stable:
-  extends:
-    - .debian:12-stable
-    - .dist-debian-container
+  before_script:
+    - CI=1 /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
+    - (echo; echo 'eval "$(/opt/homebrew/bin/brew shellenv)"') >> $HOME/.zprofile
+    - eval "$(/opt/homebrew/bin/brew shellenv)"
 
-.img-msrv:
-  extends:
-    - .debian:12-msrv
-    - .dist-debian-container
+    - CI=1 brew install pkg-config
 
-.img-nightly:
-  extends:
-    - .debian:12-nightly
-    - .dist-debian-container
+    - export GST_VERSION=1.24.2
+    - curl --proto '=https' --tlsv1.2 -o gstreamer-1.0-${GST_VERSION}-universal.pkg -sSf https://gstreamer.freedesktop.org/data/pkg/osx/${GST_VERSION}/gstreamer-1.0-${GST_VERSION}-universal.pkg
+    - curl --proto '=https' --tlsv1.2 -o gstreamer-1.0-devel-${GST_VERSION}-universal.pkg -sSf https://gstreamer.freedesktop.org/data/pkg/osx/${GST_VERSION}/gstreamer-1.0-devel-${GST_VERSION}-universal.pkg
+    - sudo installer -pkg gstreamer-1.0-${GST_VERSION}-universal.pkg -target /
+    - sudo installer -pkg gstreamer-1.0-devel-${GST_VERSION}-universal.pkg -target /
+    - export PKG_CONFIG_PATH=/Library/Frameworks/GStreamer.framework/Versions/1.0/lib/pkgconfig:$PKG_CONFIG_PATH
+    - export DYLD_FALLBACK_LIBRARY_PATH=/Library/Frameworks/GStreamer.framework/Versions/1.0/lib:$DYLD_FALLBACK_LIBRARY_PATH
+   
+    - curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y
+    - echo -e "[net]\ngit-fetch-with-cli = true" > $HOME/.cargo/config
+    
+    - source "$HOME/.cargo/env"
 
-.cargo_test_var: &cargo_test
-    - ./ci/run-cargo-test.sh
-
-.cargo test:
-  stage: "test"
-  script:
-    - *cargo_test
-
-test msrv:
-  extends:
-    - '.cargo test'
-    - .img-msrv
-  needs:
-    - job: 'trigger'
-      artifacts: false
-    - job: 'build-msrv'
-      artifacts: false
-
-test stable:
-  extends:
-    - '.cargo test'
-    - .img-stable
-  needs:
-    - job: 'trigger'
-      artifacts: false
-    - job: 'build-stable'
-      artifacts: false
-
-test stable all-features:
-  variables:
-    ALL_FEATURES: 'yes'
-    EXAMPLES_TUTORIALS: 'yes'
-  extends:
-    - '.cargo test'
-    - .img-stable
-  needs:
-    - job: 'trigger'
-      artifacts: false
-    - job: 'build-stable'
-      artifacts: false
-
-
-test nightly:
-  allow_failure: true
-  extends:
-    - '.cargo test'
-    - .img-nightly
-  needs:
-    - job: 'trigger'
-      artifacts: false
-    - job: 'build-nightly'
-      artifacts: false
-
-
-test nightly all-features:
-  allow_failure: true
-  variables:
-    ALL_FEATURES: 'yes'
-    EXAMPLES_TUTORIALS: 'yes'
-  extends:
-    - '.cargo test'
-    - .img-nightly
-  needs:
-    - job: 'trigger'
-      artifacts: false
-    - job: 'build-nightly'
-      artifacts: false
-
-.cargo test sys:
-  stage: "test"
-  script:
-    - ./ci/run-sys-cargo-test.sh
-
-test stable sys:
-  extends:
-    - '.cargo test sys'
-    - .img-stable
-  needs:
-    - job: 'trigger'
-      artifacts: false
-    - job: 'build-stable'
-      artifacts: false
-
-test msrv sys:
-  extends:
-    - '.cargo test sys'
-    - .img-msrv
-  needs:
-    - job: 'trigger'
-      artifacts: false
-    - job: 'build-msrv'
-      artifacts: false
-
-test nightly sys:
-  extends:
-    - '.cargo test sys'
-    - .img-nightly
-  needs:
-    - job: 'trigger'
-      artifacts: false
-    - job: 'build-nightly'
-      artifacts: false
-
-rustfmt:
-  extends: .img-stable
-  stage: "lint"
-  tags: [ 'placeholder-job' ]
-  script:
-    - cargo fmt --version
-    - cargo fmt -- --color=always --check
-  needs:
-    - job: 'build-stable'
-      artifacts: false
-
-check commits:
-  extends: .img-stable
-  stage: "lint"
-  tags: [ 'placeholder-job' ]
-  script:
-    - ci-fairy check-commits --textwidth 0 --no-signed-off-by
-  needs:
-    - job: 'build-stable'
-      artifacts: false
-
-typos:
-  extends: .img-stable
-  stage: "lint"
-  tags: [ 'placeholder-job' ]
-  script:
-    - typos
-  needs:
-    - job: 'build-stable'
-      artifacts: false
-
-clippy:
-  extends: .img-stable
-  stage: 'extras'
-  variables:
-    CLIPPY_LINTS: -D warnings -W unknown-lints
-  needs:
-    - job: 'trigger'
-      artifacts: false
-    - job: 'build-stable'
-      artifacts: false
-  script:
-    - ./ci/run-clippy.sh
-
-deny:
-  extends: .img-stable
-  stage: 'extras'
-  needs:
-    - job: 'build-stable'
-      artifacts: false
-  rules:
-    - if: $CI_PIPELINE_SOURCE == "schedule"
-  script:
-    - cargo update --color=always
-    - cargo deny --color=always --workspace --all-features check all
-
-gir-checks:
-  variables:
-    GIT_SUBMODULE_STRATEGY: recursive
-  extends: .img-stable
-  stage: 'extras'
-  tags: [ 'placeholder-job' ]
-  needs:
-    - job: 'build-stable'
-      artifacts: false
-  script:
-    - git submodule update --checkout
-    - python3 ci/gir-checks.py
-
-outdated:
-  extends: .img-stable
-  stage: 'extras'
-  needs:
-    - job: 'build-stable'
-      artifacts: false
-  rules:
-    - if: $CI_PIPELINE_SOURCE == "schedule"
-  script:
-    - cargo update --color=always
-    - cargo outdated --color=always --root-deps-only --exit-code 1 -v
-
-coverage:
-  allow_failure: true
-  extends:
-    - '.cargo test'
-    - .img-stable
-  stage: 'extras'
-  needs:
-    - job: 'trigger'
-      artifacts: false
-    - job: 'build-stable'
-      artifacts: false
-  variables:
-    ALL_FEATURES: 'yes'
-    RUSTFLAGS: "-Cinstrument-coverage"
-    LLVM_PROFILE_FILE: "gstreamer-rs-%p-%m.profraw"
-  script:
-    - *cargo_test
-    # generate html report
-    - grcov . --binary-path ./target/debug/ -s . -t html --branch --ignore-not-existing --ignore "*target*" --ignore "*/sys/*" --ignore "examples/*" --ignore "tutorials/*" --ignore "*/build.rs" -o ./coverage/
-    # generate cobertura report for gitlab integration
-    - grcov . --binary-path ./target/debug/ -s . -t cobertura --branch --ignore-not-existing --ignore "*target*" --ignore "*/sys/*" --ignore "examples/*" --ignore "tutorials/*" --ignore "*/build.rs" -o coverage.xml
-    # output coverage summary for gitlab parsing.
-    # TODO: use grcov once https://github.com/mozilla/grcov/issues/556 is fixed
-    - grep % coverage/index.html | head -1 ; true
-  artifacts:
-    paths:
-      - 'coverage'
-    reports:
-      coverage_report:
-        coverage_format: cobertura
-        path: coverage.xml
-
-doc-stripping:
-  variables:
-    GIT_SUBMODULE_STRATEGY: recursive
-  extends: .img-nightly
-  stage: 'extras'
-  needs:
-    - job: 'build-nightly'
-      artifacts: false
-  script:
-    - git submodule update --checkout
-    - PATH=~/.cargo/bin/:$PATH ./generator.py --gir-files-directories gir-files gst-gir-files --embed-docs
-    - PATH=~/.cargo/bin/:$PATH ./generator.py --gir-files-directories gir-files gst-gir-files --strip-docs
-    - git diff --quiet || (echo 'Files changed after running `rustdoc-stripper -s`, make sure all documentation is protected with `// rustdoc-stripper-ignore-next`!'; git diff; false)
-
-regen-check:
-  variables:
-    GIT_SUBMODULE_STRATEGY: recursive
-  extends: .img-nightly
-  stage: 'extras'
-  needs:
-    - job: 'build-nightly'
-      artifacts: false
-  script:
-    - git submodule update --checkout
-    - PATH=~/.cargo/bin/:$PATH ./generator.py --gir-files-directories gir-files gst-gir-files --yes
-    - git diff --quiet || (echo 'Files changed after running `generator.py`, make sure all submodules and generated files are in the correct version!'; git diff; false)
-
-docs:
-  variables:
-    GIT_SUBMODULE_STRATEGY: recursive
-  extends: .img-nightly
-  stage: 'extras'
-  needs:
-    - job: 'build-nightly'
-      artifacts: false
-  script:
-    - git submodule update --checkout
-    - curl --proto '=https' --tlsv1.2 -sSf -o gir-rustdoc.py
-        https://gitlab.gnome.org/World/Rust/gir-rustdoc/-/raw/main/gir-rustdoc.py
-    - chmod +x gir-rustdoc.py
-    - PATH=~/.cargo/bin/:$PATH ./generator.py --gir-files-directories gir-files gst-gir-files --embed-docs --no-fmt
-    - |
-      RUSTDOCFLAGS="$RUST_DOCS_FLAGS"
-      RUSTFLAGS="--cfg docsrs"
-      eval $(./gir-rustdoc.py pre-docs)
-      cargo +nightly doc --workspace --exclude examples --exclude tutorials --all-features --color=always --no-deps
-    - mv target/doc docs
-  artifacts:
-    paths:
-      - 'docs'
-
-# https://docs.gitlab.com/ee/user/project/pages/#how-it-works
-# GitLab automatically deploys the `public/` folder from an
-# artifact generated by the job named `pages`.  This step
-# re-uses the docs from the build-test `docs` step above.
-pages:
-  extends: .img-nightly
-  stage: 'deploy'
-  needs: [ 'docs' ]
-  interruptible: false
-  script:
-    - curl --proto '=https' --tlsv1.2 -sSf -o gir-rustdoc.py
-        https://gitlab.gnome.org/World/Rust/gir-rustdoc/-/raw/main/gir-rustdoc.py
-    - chmod +x gir-rustdoc.py
-    - ./gir-rustdoc.py html-index
-    # development docs
-    - mkdir public/git
-    - mv docs public/git/docs
-    # stable docs
-    - ./gir-rustdoc.py docs-from-artifacts
-    - ls public/
-  artifacts:
-    paths:
-      - 'public'
-  rules:
-    - if: ($CI_DEFAULT_BRANCH == $CI_COMMIT_BRANCH) && ($CI_PROJECT_NAMESPACE == $NAMESPACE)
-      when: 'manual'
-
-
-.windows rust docker build:
-  stage: 'container-final'
-  timeout: '2h'
-  needs: []
-  variables:
-    # Unlike the buildah/linux jobs, this file
-    # needs to be relative to windows-docker/ subdir
-    # as it makes life easier in the powershell script
-    #
-    # We also don't need a CONTEXT_DIR var as its also
-    # hardcoded to be windows-docker/
-    DOCKERFILE: 'ci/windows-docker/Dockerfile'
-    GST_UPSTREAM_BRANCH: 'main'
-  tags:
-    - 'windows'
-    - 'shell'
-    - '2022'
-  script:
-    # We need to pass an array and to resolve the env vars, so we can't use a variable:
-    - $DOCKER_BUILD_ARGS = @("--build-arg", "DEFAULT_BRANCH=$GST_UPSTREAM_BRANCH", "--build-arg", "RUST_VERSION=$RUST_VERSION")
-
-    - "& ci/windows-docker/container.ps1 $CI_REGISTRY $CI_REGISTRY_USER $CI_REGISTRY_PASSWORD $RUST_IMAGE $RUST_UPSTREAM_IMAGE $DOCKERFILE"
-    - |
-      if (!($?)) {
-        echo "Failed to build the image"
-        Exit 1
-      }
-
-windows rust docker stable:
-  extends: '.windows rust docker build'
-  variables:
-    RUST_IMAGE: !reference [variables, "WINDOWS_RUST_STABLE_IMAGE"]
-    RUST_UPSTREAM_IMAGE: !reference [variables, "WINDOWS_RUST_STABLE_UPSTREAM_IMAGE"]
-    RUST_VERSION: !reference [variables, "GST_RS_STABLE"]
-
-windows rust docker msrv:
-  extends: '.windows rust docker build'
-  when: 'manual'
-  variables:
-    RUST_IMAGE: !reference [variables, "WINDOWS_RUST_MINIMUM_IMAGE"]
-    RUST_UPSTREAM_IMAGE: !reference [variables, "WINDOWS_RUST_MINIMUM_UPSTREAM_IMAGE"]
-    RUST_VERSION: !reference [variables, "GST_RS_MSRV"]
-
-.msvc2019 build:
+test macos-arm64 stable:
+  extends: '.macos:arm64-stable'
   stage: 'test'
-  tags:
-    - 'docker'
-    - 'windows'
-    - '2022'
+  #needs:
+  #  - 'trigger'
   script:
-    # Skip -sys tests as they don't work
-    # https://github.com/gtk-rs/gtk3-rs/issues/54
-    #
-    # We need to build each crate separately to avoid crates like -egl,-wayland etc on windows
-    - cmd.exe /C "C:\BuildTools\Common7\Tools\VsDevCmd.bat -host_arch=amd64 -arch=amd64 &&
-      powershell ./ci/run_windows_tests.ps1"
+    - rustc --version
 
-    - |
-      if (!$?) {
-        Write-Host "Tests Failed!"
-        Exit 1
-      }
+    # Package exclusion list:
+    - export EXCLUSION_LIST=(gstreamer-editing-services-sys gstreamer-gl gstreamer-gl-sys \
+        gstreamer-gl-egl gstreamer-gl-egl-sys gstreamer-gl-wayland gstreamer-gl-wayland-sys \
+        gstreamer-gl-x11 gstreamer-gl-x11-sys gstreamer-rtp-sys)
+    - export EXCLUDE_ARGS=(`for p in ${EXCLUSION_LIST[@]}; do printf " --exclude %s" $p; done`)
 
-test windows msrv:
-  image: $WINDOWS_RUST_MINIMUM_IMAGE
-  needs:
-    - job: 'trigger'
-      artifacts: false
-    - job: 'windows rust docker msrv'
-      artifacts: false
-  extends: '.msvc2019 build'
+    - cargo build --locked --workspace ${EXCLUDE_ARGS[@]} --all-targets --color=always
+    - G_DEBUG=fatal_warnings cargo test --locked --workspace ${EXCLUDE_ARGS[@]} --all-targets --color=always
 
-test windows stable:
-  needs:
-    - job: 'trigger'
-      artifacts: false
-    - job: 'windows rust docker stable'
-      artifacts: false
-  image: "$WINDOWS_RUST_STABLE_IMAGE"
-  extends: '.msvc2019 build'
+    # --all-features
+    - cargo build --locked --workspace ${EXCLUDE_ARGS[@]} --all-targets --all-features --color=always
+    - G_DEBUG=fatal_warnings cargo test --locked --workspace ${EXCLUDE_ARGS[@]} --all-targets --all-features --color=always
+    
+    # --no-default-features
+    - cargo build --keep-going --locked --workspace ${EXCLUDE_ARGS[@]} --all-targets --no-default-features --color=always
+    - G_DEBUG=fatal_warnings cargo test --locked --workspace ${EXCLUDE_ARGS[@]} --all-targets --no-default-features --color=always
+
+    # examples
+    # Excluding anything gl, fd_allocator & d3d11videosink
+    - export EXAMPLES_FEATURES="--features=rtsp-server,rtsp-server-record,pango-cairo,overlay-composition,allocators,gst-play,gst-player,ges,image,cairo-rs,gst-video/v1_18"
+    - export INCLUSION_LIST=(appsink appsrc custom_events custom_meta decodebin debug_ringbuffer \
+        encodebin events iterator launch_glib_main launch transmux pad_probes play playbin player \
+        queries rtpfecclient rtpfecserver rtsp-server rtsp-server-subclass rtsp-server-custom-auth \
+        tagsetter toc futures glib-futures rtso-server-record discoverer pango-cairo \
+        overlay-composition ges subclass video_converter thumbnail cairo_compositor \
+        audio_multichannel_interleave)
+    - export INCLUDE_ARGS=(`for p in ${INCLUSION_LIST[@]}; do printf " --bin %s" $p; done`)
+    - cargo build --locked --color=always -p examples ${INCLUDE_ARGS[@]} "$EXAMPLES_FEATURES"
+
+    # tutorials
+    - cargo build --locked --color=always -p tutorials --bins