cli binary generation

pranshi06 · pranshi06 · commit a09e35827d4e · 2024-09-18T00:20:29.000+05:30
diff --git a/.github/workflows/ship.yaml b/.github/workflows/ship.yaml
@@ -0,0 +1,247 @@
+name: ship
+
+on:
+  push:
+
+jobs:
+  nix-build:
+    name: nix build
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        target:
+          - x86_64-linux
+          - aarch64-linux
+    steps:
+      - name: Checkout 🛎️
+        uses: actions/checkout@v4
+
+      - name: Install Nix ❄
+        uses: cachix/install-nix-action@V27
+        with:
+          github_access_token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Set up the Nix Cache 🔌
+        uses: cachix/cachix-action@v15
+        with:
+          name: hasura-v3-dev
+          authToken: ${{ secrets.CACHIX_AUTH_TOKEN }}
+
+      - name: Build a binary with Nix
+        run: nix build --print-build-logs '.#${{ matrix.target }}'
+
+      - name: Build a Docker image with Nix
+        run: nix build --print-build-logs '.#docker-${{ matrix.target }}'
+
+      # scream into Slack if something goes wrong
+      - name: Report Status
+        if: always() && github.ref == 'refs/heads/main'
+        uses: ravsamhq/notify-slack-action@v2
+        with:
+          status: ${{ job.status }}
+          notify_when: failure
+          notification_title: "😧 Error on <{repo_url}|{repo}>"
+          message_format: "🐴 *{workflow}* {status_message} for <{repo_url}|{repo}>"
+        env:
+          SLACK_WEBHOOK_URL: ${{ secrets.BROKEN_BUILD_SLACK_WEBHOOK_URL }}
+
+  push-docker-images:
+    name: push Docker images
+    needs:
+      - nix-build
+    runs-on: ubuntu-latest
+    # Only run on the `main` branch or version tags.
+    # Note we currently tag the image with 'latest', so will want to stop doing
+    # so if we run this on PR branches, etc.
+    if: (github.ref == 'refs/heads/main' || startsWith(github.ref, 'refs/tags/v'))
+    permissions:
+      contents: read
+      id-token: write
+      packages: write
+    steps:
+      - name: Checkout 🛎️
+        uses: actions/checkout@v4
+
+      - name: Install Nix ❄
+        uses: cachix/install-nix-action@V27
+        with:
+          github_access_token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Set up the Nix Cache 🔌
+        uses: cachix/cachix-action@v15
+        with:
+          name: hasura-v3-dev
+          authToken: ${{ secrets.CACHIX_AUTH_TOKEN }}
+
+      - id: gcloud-auth
+        name: Authenticate to Google Cloud 🔑
+        uses: google-github-actions/auth@v2
+        with:
+          token_format: access_token
+          service_account: "hasura-ci-docker-writer@hasura-ddn.iam.gserviceaccount.com"
+          workload_identity_provider: "projects/1025009031284/locations/global/workloadIdentityPools/hasura-ddn/providers/github"
+
+      - name: Login to Google Container Registry 📦
+        uses: "docker/login-action@v3"
+        with:
+          registry: "us-docker.pkg.dev"
+          username: "oauth2accesstoken"
+          password: "${{ steps.gcloud-auth.outputs.access_token }}"
+
+      - name: Login to GitHub Container Registry 📦
+        uses: docker/login-action@v3
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Push Docker images to Google Container Registry 🚢
+        run: nix run .#publish-docker-image '${{ github.ref }}' 'us-docker.pkg.dev/hasura-ddn/ddn/ndc-bigquery'
+
+      - name: Push Docker images to GitHub Packages 🚢
+        run: nix run .#publish-docker-image '${{ github.ref }}' 'ghcr.io/hasura/ndc-bigquery'
+
+      # scream into Slack if something goes wrong
+      - name: Report Status
+        if: always()
+        uses: ravsamhq/notify-slack-action@v2
+        with:
+          status: ${{ job.status }}
+          notify_when: failure
+          notification_title: "😧 Error on <{repo_url}|{repo}>"
+          message_format: "🐴 *{workflow}* {status_message} for <{repo_url}|{repo}>"
+        env:
+          SLACK_WEBHOOK_URL: ${{ secrets.BROKEN_BUILD_SLACK_WEBHOOK_URL }}
+
+  build-cli-binaries:
+    name: build the CLI binaries
+    strategy:
+      matrix:
+        include:
+          - runner: ubuntu-20.04
+            target: x86_64-unknown-linux-gnu
+          - runner: ubuntu-20.04
+            target: aarch64-unknown-linux-gnu
+            linux-packages: gcc-aarch64-linux-gnu
+            linker: /usr/bin/aarch64-linux-gnu-gcc
+          - runner: macos-latest
+            target: x86_64-apple-darwin
+          - runner: macos-latest
+            target: aarch64-apple-darwin
+          - runner: windows-latest
+            target: x86_64-pc-windows-msvc
+            extension: .exe
+            extra-rust-flags: "-C target-feature=+crt-static"
+    runs-on: ${{ matrix.runner }}
+    env:
+      CARGO_BUILD_TARGET: ${{ matrix.target }}
+      CARGO_NET_GIT_FETCH_WITH_CLI: "true"
+      RUSTFLAGS: "-D warnings" # fail on warnings
+    defaults:
+      run:
+        shell: bash
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: install protoc
+        uses: arduino/setup-protoc@v3
+        with:
+          version: "25.x"
+          repo-token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: install tools
+        run: |
+          rustup show
+          rustup target add ${{ matrix.target }}
+
+      - name: install other packages required
+        if: matrix.linux-packages
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y ${{ matrix.linux-packages }}
+
+      - uses: Swatinem/rust-cache@v2
+        with:
+          shared-key: "build-${matrix.runner}" # share the cache across jobs
+
+      - name: build the CLI
+        run: |
+          # If we're on a tag, use the tag name as the release version.
+          if [[ "$GITHUB_REF_TYPE" == 'tag' ]]; then
+            # Ensure that the version specified in Cargo.toml is the same as the tag (with a 'v' prefix).
+            CARGO_VERSION="$(cargo metadata --format-version=1 | jq -r '.packages | .[] | select(.name == "ndc-bigquery") | .version')"
+            echo "Git tag: ${GITHUB_REF_NAME}"
+            echo "Cargo version: ${CARGO_VERSION}"
+
+            if [[ "$GITHUB_REF_NAME" != "v${CARGO_VERSION}" ]]; then
+              echo >&2 "The Git tag is \"${GITHUB_REF_NAME}\", but the version in Cargo.toml is \"${CARGO_VERSION}\"."
+              echo >&2 'These must be the same, with a "v" prefix for the tag. Aborting.'
+              exit 1
+            fi
+            export RELEASE_VERSION="$GITHUB_REF_NAME"
+            echo "RELEASE_VERSION = ${RELEASE_VERSION}"
+          fi
+
+          if [[ -n '${{ matrix.linker }}' ]]; then
+            TARGET_SCREAMING="$(echo '${{ matrix.target }}' | tr '[:lower:]' '[:upper:]' | tr '-' '_')"
+            echo "CARGO_TARGET_${TARGET_SCREAMING}_LINKER"='${{ matrix.linker }}'
+            declare "CARGO_TARGET_${TARGET_SCREAMING}_LINKER"='${{ matrix.linker }}'
+            export "CARGO_TARGET_${TARGET_SCREAMING}_LINKER"
+          fi
+
+          if [[ -n '${{ matrix.extra-rust-flags }}' ]]; then
+            RUSTFLAGS="${RUSTFLAGS} ${{ matrix.extra-rust-flags }}"
+            export RUSTFLAGS
+          fi
+          echo "RUSTFLAGS = ${RUSTFLAGS}"
+
+          echo "Building for target: ${CARGO_BUILD_TARGET}"
+          cargo build --release --package=ndc-bigquery-cli
+
+          mkdir -p release
+          mv -v target/${{ matrix.target }}/release/ndc-bigquery-cli release/ndc-bigquery-cli-${{ matrix.target }}${{ matrix.extension }}
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: ndc-bigquery-cli-${{ matrix.target }}
+          path: release
+          if-no-files-found: error
+
+  release:
+    name: release to GitHub
+    needs:
+      - push-docker-images # not strictly necessary, but if this fails, we should abort
+      - build-cli-binaries
+    runs-on: ubuntu-latest
+    # We release when a tag is pushed.
+    if: startsWith(github.ref, 'refs/tags/v')
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/download-artifact@v4
+        with:
+          path: release/artifacts
+          merge-multiple: true
+
+      - name: generate SHA-256 checksums
+        run: |
+          cd release/artifacts
+          sha256sum * > ./sha256sum
+
+      - name: generate a changelog
+        run: |
+          ./scripts/release-notes.py "${GITHUB_REF_NAME}" >> release/notes.md
+
+      - name: generate a connector package
+        run: |
+          chmod +x ./release/artifacts/ndc-bigquery-cli-*
+          mkdir release/package
+          ./release/artifacts/ndc-bigquery-cli-x86_64-unknown-linux-gnu --context=release/package initialize --with-metadata
+          tar vczf release/artifacts/package.tar.gz -C release/package .
+
+      - name: create a draft release
+        uses: ncipollo/release-action@v1
+        with:
+          draft: true
+          bodyFile: release/notes.md
+          artifacts: release/artifacts/*
diff --git a/changelog.md b/changelog.md
@@ -0,0 +1,21 @@
+# Changelog
+
+## [Unreleased]
+
+### Added
+
+### Changed
+
+### Fixed
+
+## [v0.1.0] - 2024-09-19
+
+- Initial release with support of ndc-spec v0.1.6
+  - Support for CLI plugin for Hasura v3 CLI, which allows the CLI to
+    introspect the database on demand.
+  - The default port was changed from 8100 to 8080.
+
+<!-- end -->
+
+[Unreleased]: https://github.com/hasura/ndc-bigquery/compare/v0.2.0...HEAD
+[v0.1.0]: https://github.com/hasura/ndc-bigquery/releases/tag/v0.1.0
diff --git a/crates/cli/readme.md b/crates/cli/readme.md
@@ -0,0 +1,26 @@
+# ndc-bigquery-cli
+
+ndc-bigquery-cli is used to configure a deployment of ndc-bigquery.
+It is intended to be automatically downloaded and invoked via the Hasura CLI, as a plugin.
+
+## Create a configuration
+
+Create a configuration in a new directory using the following commands:
+
+1. Initialize a configuration:
+
+   ```sh
+   export HASURA_BIGQUERY_SERVICE_KEY='<bigquery-service-key>'
+   export HASURA_BIGQUERY_PROJECT_ID='<bigquery-project-id>'
+   export HASURA_BIGQUERY_DATASET_ID='<bigquery-dataset-id>'
+   cargo run --bin ndc-bigquery-cli -- --context='<directory>' initialize
+   ```
+
+2. Update the configuration by introspecting the database:
+
+   ```sh
+   export HASURA_BIGQUERY_SERVICE_KEY='<bigquery-service-key>'
+   export HASURA_BIGQUERY_PROJECT_ID='<bigquery-project-id>'
+   export HASURA_BIGQUERY_DATASET_ID='<bigquery-dataset-id>'
+   cargo run --bin ndc-bigquery-cli -- --context='<directory>' update
+   ```
diff --git a/crates/cli/src/lib.rs b/crates/cli/src/lib.rs
@@ -72,6 +72,10 @@ pub async fn run(command: Command, context: Context<impl Environment>) -> anyhow
 /// Optionally, this can also create the connector metadata, which is used by the Hasura CLI to
 /// automatically work with this CLI as a plugin.
 async fn initialize(with_metadata: bool, context: Context<impl Environment>) -> anyhow::Result<()> {
+    let _ = context
+        .context_path
+        .join(configuration::version1::CONFIGURATION_FILENAME);
+    fs::create_dir_all(&context.context_path).await?;
     // refuse to initialize the directory unless it is empty
     let mut items_in_dir = fs::read_dir(&context.context_path).await?;
     if items_in_dir.next_entry().await?.is_some() {
diff --git a/crates/configuration/src/values/pool_settings.rs b/crates/configuration/src/values/pool_settings.rs
@@ -1,7 +1,7 @@
 use schemars::JsonSchema;
 use serde::{Deserialize, Serialize};
 
-/// Settings for the PostgreSQL connection pool
+/// Settings for the BigQuery connection pool
 #[derive(Debug, Clone, PartialEq, Serialize, Deserialize, JsonSchema)]
 pub struct PoolSettings {
     /// maximum number of pool connections
diff --git a/scripts/release-notes.py b/scripts/release-notes.py
@@ -0,0 +1,64 @@
+#!/usr/bin/env python3
+
+# Generates the release notes for a GitHub release automatically.
+#
+# These notes consist of:
+#   1. the Docker image name
+#   2. the part of the changelog corresponding to the given version
+
+import argparse
+import sys
+
+def main():
+    parser = argparse.ArgumentParser()
+    parser.add_argument("version")
+    args = parser.parse_args()
+
+    print_docker_image(args.version)
+    print_changelog_for_version(args.version)
+
+def print_docker_image(version):
+    print('The connector Docker image is:')
+    print('')
+    print(f'    ghcr.io/hasura/ndc-bigquery:{version}')
+    print('')
+
+def print_changelog_for_version(version):
+    recording = False
+    changelog_lines = []
+    with open("changelog.md") as file:
+        for line in file:
+            line = line.rstrip() # remove trailing spaces and newline
+            # start recording lines when we find the entry corresponding to the
+            # given version
+            if line.startswith(f"## [{version}]"):
+                recording = True
+                continue
+            if recording:
+                # stop when we hit the next section or the end
+                if line.startswith("## ") or line == "<!-- end -->":
+                    break
+                changelog_lines.append(line)
+
+        # discard blank lines at the start or end
+        try:
+            while changelog_lines[0] == "":
+                changelog_lines.pop(0)
+            while changelog_lines[-1] == "":
+                changelog_lines.pop()
+        except IndexError:
+            pass
+
+    # if it's empty, we have failed
+    if not changelog_lines:
+        print(f"Could not find a changelog for version {version}.", file=sys.stderr)
+        sys.exit(1)
+
+    # print the result
+    print('## Changelog')
+    print()
+    for line in changelog_lines:
+        print(line)
+
+if __name__ == '__main__':
+    main()
