Merge pull request #1 from Nuvindu/main

Add initial implementation of the Avro Serializer for Confluent Schema Registry Connector

.gitattributes

@@ -0,0 +1,8 @@
+#
+# https://help.github.com/articles/dealing-with-line-endings/
+#
+# Linux start script should use lf
+/gradlew        text eol=lf
+
+# These are Windows script files and should use crlf
+*.bat           text eol=crlf

.github/CODEOWNERS

@@ -0,0 +1,7 @@
+# Lines starting with '#' are comments.
+# Each line is a file pattern followed by one or more owners.
+
+# See: https://help.github.com/articles/about-codeowners/
+
+# These owners will be the default owners for everything in the repo.
+*       @Nuvindu @ThisaruGuruge @shafreenAnfar

.github/workflows/build-with-bal-test-graalvm.yml

@@ -0,0 +1,19 @@
+name: GraalVM Check
+
+on:
+  schedule:
+    - cron: "30 12 * * *"
+  workflow_dispatch:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.run_id }}
+  cancel-in-progress: true
+
+jobs:
+  call_stdlib_workflow:
+    name: Run StdLib Workflow
+    if: ${{ github.event_name != 'schedule' || (github.event_name == 'schedule' && github.repository_owner == 'ballerina-platform') }}
+    uses: ballerina-platform/ballerina-standard-library/.github/workflows/build-with-bal-test-graalvm-connector-template.yml@main
+    secrets: inherit
+    with:
+      additional-build-flags: "-x :confluent.cavroserdes-examples:build"

.github/workflows/ci.yml

@@ -0,0 +1,18 @@
+name: Build
+
+on:
+  push:
+    branches:
+      - main
+      - 2201.[0-9]+.x
+  repository_dispatch:
+    types: check_connector_for_breaking_changes
+
+jobs:
+  call_workflow:
+    name: Run Connector Build Workflow
+    if: ${{ github.repository_owner == 'ballerina-platform' }}
+    uses: ballerina-platform/ballerina-standard-library/.github/workflows/build-connector-template.yml@main
+    secrets: inherit
+    with:
+      repo-name: module-ballerinax-confluent.cavroserdes

.github/workflows/daily-build.yml

@@ -0,0 +1,14 @@
+name: Daily build
+
+on:
+  schedule:
+    - cron: "30 0 * * *"
+
+jobs:
+  call_workflow:
+    name: Run Daily Build Workflow
+    if: ${{ github.repository_owner == 'ballerina-platform' }}
+    uses: ballerina-platform/ballerina-standard-library/.github/workflows/daily-build-connector-template.yml@main
+    secrets: inherit
+    with:
+      repo-name: module-ballerinax-confluent.cavroserdes

.github/workflows/dev-stg-release.yml

@@ -0,0 +1,22 @@
+name: Publish to the Ballerina Dev\Stage Central
+
+on:
+  workflow_dispatch:
+    inputs:
+      environment:
+        type: choice
+        description: Select Environment
+        required: true
+        options:
+          - DEV CENTRAL
+          - STAGE CENTRAL
+
+jobs:
+  call_workflow:
+    name: Run Dev\Stage Central Publish Workflow
+    if: ${{ github.repository_owner == 'ballerina-platform' }}
+    uses: ballerina-platform/ballerina-standard-library/.github/workflows/dev-stage-central-publish-connector-template.yml@main
+    secrets: inherit
+    with:
+      environment: ${{ github.event.inputs.environment }}
+      additional-publish-flags: "-x :confluent.cavroserdes-examples:build"

.github/workflows/pull-request.yml

@@ -0,0 +1,16 @@
+name: PR Build
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.run_id }}
+  cancel-in-progress: true
+
+on: pull_request
+
+jobs:
+  call_workflow:
+    name: Run PR Build Workflow
+    if: ${{ github.repository_owner == 'ballerina-platform' }}
+    uses: ballerina-platform/ballerina-standard-library/.github/workflows/pr-build-connector-template.yml@main
+    secrets: inherit
+    with:
+      additional-test-flags: ${{ github.event.pull_request.head.repo.full_name != github.repository && '-x test' || ''}}

.github/workflows/release.yml

@@ -0,0 +1,16 @@
+name: Publish Release
+
+on:
+  workflow_dispatch:
+  repository_dispatch:
+    types: [ stdlib-release-pipeline ]
+
+jobs:
+  call_workflow:
+    name: Run Release Workflow
+    if: ${{ github.repository_owner == 'ballerina-platform' }}
+    uses: ballerina-platform/ballerina-standard-library/.github/workflows/release-package-connector-template.yml@main
+    secrets: inherit
+    with:
+      package-name: confluent.cavroserdes
+      package-org: ballerinax

.github/workflows/trivy-scan.yml

@@ -0,0 +1,15 @@
+name: Trivy
+
+on:
+  workflow_dispatch:
+  schedule:
+    - cron:  "30 22 * * *"
+
+jobs:
+  call_workflow:
+    name: Run Trivy Scan Workflow
+    if: ${{ github.repository_owner == 'ballerina-platform' }}
+    uses: ballerina-platform/ballerina-standard-library/.github/workflows/trivy-scan-template.yml@main
+    secrets: inherit
+    with:
+      additional-build-flags: "-x :confluent.cavroserdes-examples:build"

.gitignore

@@ -1,24 +1,68 @@
 # Compiled class file
 *.class
+*.balx
 
 # Log file
 *.log
 
+#Config file
+Config.toml
+**/Config.toml
+
 # BlueJ files
 *.ctxt
 
 # Mobile Tools for Java (J2ME)
 .mtj.tmp/
 
+# .DS_Store files
+*.DS_Store
+
 # Package Files #
 *.jar
+!gradle/wrapper/gradle-wrapper.jar
 *.war
-*.nar
 *.ear
 *.zip
 *.tar.gz
 *.rar
+*.deb
 
 # virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
 hs_err_pid*
-replay_pid*
+
+# Ignore everything in this directory
+target
+.idea
+.classpath
+.settings
+.project
+*.iml
+*.iws
+*.ipr
+.idea
+.m2
+.vscode/
+# Ignore ballerina files
+accessToken.bal
+temp.bal.ballerina/
+target/
+.DS_Store
+*Ballerina.lock
+.ballerina
+
+# Ignore Gradle project-specific cache directory
+.gradle
+
+# Ignore Gradle build output directory
+build
+generated
+
+# Ignore Docker env file
+docker.env
+
+# Ignore environment files
+*.env
+
+# Ignore all Dependencies.toml files in the examples directory
+examples/**/Dependencies.toml

README.md

@@ -1,2 +1,160 @@
-# module-ballerinax-confluent.cavroserdes
-The Ballerina Avro Ser/Des package for Confluent provides APIs which will hide the complexities in serializing and deserializing data using Avro schemas along with the registration and retrieval of these schemas from the schema registry
+# Ballerina Confluent Avro Serialization/Deserialization Connector
+
+[![Build](https://github.com/ballerina-platform/module-ballerinax-confluent.cavroserdes/actions/workflows/ci.yml/badge.svg)](https://github.com/ballerina-platform/module-ballerinax-confluent.cavroserdes/actions/workflows/ci.yml)
+[![Trivy](https://github.com/ballerina-platform/module-ballerinax-confluent.cavroserdes/actions/workflows/trivy-scan.yml/badge.svg)](https://github.com/ballerina-platform/module-ballerinax-confluent.cavroserdes/actions/workflows/trivy-scan.yml)
+[![GraalVM Check](https://github.com/ballerina-platform/module-ballerinax-confluent.cavroserdes/actions/workflows/build-with-bal-test-graalvm.yml/badge.svg)](https://github.com/ballerina-platform/module-ballerinax-confluent.cavroserdes/actions/workflows/build-with-bal-test-graalvm.yml)
+[![GitHub Last Commit](https://img.shields.io/github/last-commit/ballerina-platform/module-ballerinax-confluent.cavroserdes.svg)](https://github.com/ballerina-platform/module-ballerinax-confluent.cavroserdes/commits/main)
+[![GitHub Issues](https://img.shields.io/github/issues/ballerina-platform/ballerina-library/module/confluent.cavroserdes.svg?label=Open%20Issues)](https://github.com/ballerina-platform/ballerina-library/labels/module%2Fconfluent.cavroserdes)
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+
+[Avro Serializer/Deserializer for Confluent Schema Registry](https://docs.confluent.io/platform/current/schema-registry/fundamentals/serdes-develop/serdes-avro.html) is an Avro serializer/deserializer designed to work with the Confluent Schema Registry. It is designed to not include the message schema in the message payload but instead includes the schema ID.
+
+The Ballerina Avro Serializer/Deserializer for Confluent Schema Registry connector integrates with the Confluent Schema Registry for Avro serialization and deserialization.
+
+## Quickstart
+
+To use the Confluent schema registry connector in your Ballerina project, modify the `.bal` file as follows.
+
+### Step 1: Import the module
+
+Import the `ballerinax/confluent.cavroserdes` module into your Ballerina project.
+
+```ballerina
+import ballerinax/confluent.cavroserdes;
+```
+
+### Step 2: Instantiate a new connector
+
+```ballerina
+configurable string baseUrl = ?;
+configurable int identityMapCapacity = ?;
+configurable map<anydata> originals = ?;
+configurable map<string> headers = ?;
+
+cavroserdes:Client avroSerDes = check new ({
+    baseUrl,
+    identityMapCapacity,
+    originals,
+    headers
+});
+```
+
+### Step 3: Invoke the connector operation
+
+You can now utilize the operations available within the connector.
+
+```ballerina
+public function main() returns error? {
+   string schema = string `
+      {
+         "type": "int",
+         "name" : "value", 
+         "namespace": "data"
+      }`;
+
+   int value = 1;
+   byte[] bytes = check avroSerDes->serialize(schema, value, "subject");
+   int number = check avroSerDes->deserialize(bytes);
+}
+```
+
+### Step 4: Run the Ballerina application
+
+Use the following command to compile and run the Ballerina program.
+
+```bash
+bal run
+```
+
+## Issues and projects
+
+The **Issues** and **Projects** tabs are disabled for this repository as this is part of the Ballerina library. To report bugs, request new features, start new discussions, view project boards, etc., visit the Ballerina library [parent repository](https://github.com/ballerina-platform/ballerina-library).
+
+This repository only contains the source code for the package.
+
+## Building from the source
+
+### Prerequisites
+
+1. Download and install Java SE Development Kit (JDK) version 17. You can download it from either of the following sources:
+
+   - [Oracle JDK](https://www.oracle.com/java/technologies/downloads/)
+   - [OpenJDK](https://adoptium.net/)
+
+    > **Note:** After installation, remember to set the `JAVA_HOME` environment variable to the directory where JDK was installed.
+
+2. Download and install [Ballerina Swan Lake](https://ballerina.io/).
+
+3. Download and install [Docker](https://www.docker.com/get-started).
+
+    > **Note**: Ensure that the Docker daemon is running before executing any tests.
+
+4. Generate a Github access token with read package permissions, then set the following `env` variables:
+
+    ```bash
+   export packageUser=<Your GitHub Username>
+   export packagePAT=<GitHub Personal Access Token>
+    ```
+
+### Build options
+
+Execute the commands below to build from the source.
+
+1. To build the package:
+
+   ```bash
+   ./gradlew clean build
+   ```
+
+2. To run the tests:
+
+   ```bash
+   ./gradlew clean test
+   ```
+
+3. To build the without the tests:
+
+   ```bash
+   ./gradlew clean build -x test
+   ```
+
+4. To debug package with a remote debugger:
+
+   ```bash
+   ./gradlew clean build -Pdebug=<port>
+   ```
+
+5. To debug with Ballerina language:
+
+   ```bash
+   ./gradlew clean build -PbalJavaDebug=<port>
+   ```
+
+6. Publish the generated artifacts to the local Ballerina central repository:
+
+   ```bash
+   ./gradlew clean build -PpublishToLocalCentral=true
+   ```
+
+7. Publish the generated artifacts to the Ballerina central repository:
+
+   ```bash
+   ./gradlew clean build -PpublishToCentral=true
+   ```
+
+## Contributing to Ballerina
+
+As an open source project, Ballerina welcomes contributions from the community.
+
+For more information, go to the [contribution guidelines](https://github.com/ballerina-platform/ballerina-lang/blob/master/CONTRIBUTING.md).
+
+## Code of conduct
+
+All contributors are encouraged to read the [Ballerina Code of Conduct](https://ballerina.io/code-of-conduct).
+
+## Useful links
+
+- For more information go to the [confluent.cavroderdes](https://central.ballerina.io/ballerinax/confluent.cavroserdes/latest) library.
+- Discuss code changes of the Ballerina project in [ballerina-dev@googlegroups.com](mailto:ballerina-dev@googlegroups.com).
+- Chat live with us via our [Discord server](https://discord.gg/ballerinalang).
+- Post all technical questions on Stack Overflow with the [#ballerina](https://stackoverflow.com/questions/tagged/ballerina) tag.