examples.yaml

# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements.  See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership.  The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License.  You may obtain a copy of the License at
#
#   http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied.  See the License for the
# specific language governing permissions and limitations
# under the License.

name: examples

on:
  push:
    branches:
      - main
  pull_request:
    branches:
      - main
    paths:
      - 'examples/**'
      - 'CMakeLists.txt'
      - '.github/workflows/examples.yaml'
      - 'src/nanoarrow/**'
      - 'src/extensions/**'

jobs:
  examples:

    runs-on: ubuntu-latest
    env:
      VERBOSE: 1

    steps:
      - name: Checkout repo
        uses: actions/checkout@v4
        with:
          fetch-depth: 0
      - uses: actions/setup-python@v5
        with:
          python-version: '3.x'

      - name: Install dependencies
        run: |
          sudo apt-get install -y cmake

      - name: Minimal CMake Example
        run: |
          cd examples/cmake-minimal
          mkdir build && cd build
          cmake ..
          cmake --build .

          ./example_cmake_minimal_app

      - name: Minimal Vendored Example
        run: |
          cd examples/vendored-minimal
          python3 ../../ci/scripts/bundle.py --source-output-dir=src --include-output-dir=src

          cd src
          gcc -c library.c nanoarrow.c
          ar rcs libexample_vendored_minimal_library.a library.o nanoarrow.o
          gcc -o example_vendored_minimal_app app.c libexample_vendored_minimal_library.a

          ./example_vendored_minimal_app

      - name: Ipc CMake Example
        run: |
          cd examples/cmake-ipc
          mkdir build && cd build
          cmake ..
          cmake --build .

          cat ../schema-valid.arrows | ./example_cmake_ipc_app

      - name: Ipc Vendored Example
        run: |
          cd examples/vendored-ipc
          python3 ../../ci/scripts/bundle.py \
            --source-output-dir=src \
            --include-output-dir=src \
            --symbol-namespace=MyProject \
            --with-ipc \
            --with-flatcc

          cd src
          gcc -c library.c nanoarrow.c flatcc.c nanoarrow_ipc.c -I.
          ar rcs libexample_vendored_ipc_library.a library.o nanoarrow.o nanoarrow_ipc.o flatcc.o
          gcc -o example_vendored_ipc_app app.c libexample_vendored_ipc_library.a

          cat ../schema-valid.arrows | ./example_vendored_ipc_app

      - name: Getting Started Tutorial Example
        run: |
          cd examples/linesplitter
          mkdir build && cd build
          cmake ..
          cmake --build .
          ctest .

      - name: Comprehensive CMake example
        run: |
          cd examples/cmake-scenarios
          ./build.sh
          for dir in scratch/build*; do
            ./${dir}/minimal_cpp_app;
            echo ;
          done

      - name: Meson example
        run: |
          python3 -m pip install meson ninja
          cd examples/meson-minimal
          meson setup builddir
          meson compile -C builddir

          ./builddir/example_meson_minimal_app

      - name: Python example
        run: |
          python3 -m pip install examples/python-package
          python3 -c "import schema_printer"