This is an automated email from the ASF dual-hosted git repository.
davsclaus pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel-jbang-examples.git
The following commit(s) were added to refs/heads/main by this push:
new 5ce96d1 CAMEL-24808: rung 9 of the ladder: cloud (#87)
5ce96d1 is described below
commit 5ce96d1f1a32b792d8182d8238108c2aca043cad
Author: Claus Ibsen <[email protected]>
AuthorDate: Fri Sep 18 21:21:20 2026 +0200
CAMEL-24808: rung 9 of the ladder: cloud (#87)
cloud/aws-sqs is rewritten around the shop: each order is put on an SQS
queue called shipments and a courier route takes it off, with the aws2-sqs
component configured once at component level so both endpoints only name the
queue. Locally the queue lives on the LocalStack that camel infra run aws sqs
starts, and the README shows the properties for real AWS. The Citrus test
starts LocalStack through the testcontainers action, since the camel infra
action derives the artifact name camel [...]
Co-Authored-By: Claude Fable 5.1 <[email protected]>
Claude-Session: https://claude.ai/code/session_01Bp3538HRBPMQkb5ta9xRaj
---
camel-jbang-example-catalog.json | 35 +++++--
cloud/aws-sqs/README.md | 116 +++++++++++-----------
cloud/aws-sqs/application.properties | 40 ++++----
cloud/aws-sqs/aws-sqs.camel.yaml | 36 +++++++
cloud/aws-sqs/http-to-aws-sqs.camel.yaml | 33 ------
cloud/aws-sqs/metadata.json | 29 ++++--
cloud/aws-sqs/orders/order-1001.json | 2 +
cloud/aws-sqs/orders/order-1002.json | 2 +
cloud/aws-sqs/orders/order-1003.json | 2 +
cloud/aws-sqs/test/application.test.properties | 23 -----
cloud/aws-sqs/test/aws-sqs.citrus.it.yaml | 45 +++++++++
cloud/aws-sqs/test/citrus-application.properties | 2 -
cloud/aws-sqs/test/http-to-aws-sqs.citrus.it.yaml | 42 --------
13 files changed, 215 insertions(+), 192 deletions(-)
diff --git a/camel-jbang-example-catalog.json b/camel-jbang-example-catalog.json
index 0967763..22dcf51 100644
--- a/camel-jbang-example-catalog.json
+++ b/camel-jbang-example-catalog.json
@@ -340,28 +340,47 @@
},
{
"name": "cloud/aws-sqs",
- "title": "AWS SQS Sink",
- "description": "A POST to /news on port 8080 pushes the request body
as a message to an AWS SQS queue through the aws-sqs-sink Kamelet; credentials,
region and queue come from application.properties.",
+ "title": "AWS SQS",
+ "description": "Each of the three orders is put on an Amazon SQS queue
called shipments and a courier route takes it off and logs the order, country
and line count; locally the queue lives on the LocalStack that camel infra run
aws sqs starts, and the same properties point at real AWS.",
"level": "cloud",
"teaches": {
"components": [
- "platform-http",
- "kamelet"
+ "aws2-sqs",
+ "file",
+ "log"
+ ],
+ "eips": [
+ "setHeader",
+ "unmarshal"
+ ],
+ "languages": [
+ "simple",
+ "jsonpath"
+ ],
+ "dataformats": [
+ "json"
]
},
"tags": [
+ "shop",
"aws",
"sqs",
- "http",
- "cloud"
+ "cloud",
+ "messaging"
],
"bundled": false,
- "requiresDocker": false,
+ "requiresDocker": true,
"hasCitrusTests": true,
"files": [
"README.md",
"application.properties",
- "http-to-aws-sqs.camel.yaml"
+ "aws-sqs.camel.yaml",
+ "orders/order-1001.json",
+ "orders/order-1002.json",
+ "orders/order-1003.json"
+ ],
+ "infraServices": [
+ "aws"
]
},
{
diff --git a/cloud/aws-sqs/README.md b/cloud/aws-sqs/README.md
index f7051ee..5e28424 100644
--- a/cloud/aws-sqs/README.md
+++ b/cloud/aws-sqs/README.md
@@ -1,96 +1,92 @@
-# AWS SQS sink
+# AWS SQS
-In this sample you'll use the AWS SQS Sink Kamelet.
-The Camel integration exposes a Http service and for each incoming request the
message body data is pushed to an AWS SQS queue.
+Shipments are handed to the courier through an Amazon SQS queue: the shop puts
each order on the queue, the
+courier's system takes it off. Nothing here needs an AWS account: the Camel
CLI starts LocalStack, an AWS
+look-alike, in a container, and the same two routes run against the real
service with other properties.
-## Install Camel CLI
+## What you will see
+
+```text
+INFO ... aws-sqs.camel.yaml:22 : Order ORD-1001 handed over on the shipments
queue
+INFO ... aws-sqs.camel.yaml:22 : Order ORD-1002 handed over on the shipments
queue
+INFO ... aws-sqs.camel.yaml:22 : Order ORD-1003 handed over on the shipments
queue
+INFO ... aws-sqs.camel.yaml:35 : Courier picked up ORD-1001 for DK: 2 line(s)
+INFO ... aws-sqs.camel.yaml:35 : Courier picked up ORD-1002 for DE: 1 line(s)
+INFO ... aws-sqs.camel.yaml:35 : Courier picked up ORD-1003 for US: 3 line(s)
+```
-<!-- see ../../install.adoc for installation instructions -->
+## Install Camel CLI
-## Setup the AWS SQS Queue
+<!-- see installation instructions in ../../install.adoc -->
-### Setting up AWS SQS using Camel Infra
+## Run it
-AWS SQS can be easily configured and run using Camel Infra.
-To start an AWS SQS instance, run the following command:
+The example needs a running SQS, which the Camel CLI starts for you as
LocalStack in a container (Docker or
+Podman must be running). In one terminal:
```shell
camel infra run aws sqs
```
-Add or replace the following information to the `application.properties` file:
-
-```properties
-aws.secretKey=secretKey
-aws.accessKey=accessKey
-aws.region=us-east-1
-aws.overrideEndpoint=true
-aws.uriEndpointOverride=http://localhost:4566
-autoCreateQueue=true
-```
-
-Note: These configuration values can be retrieved from the JSON output
generated by the `camel infra run aws sqs` command.
-
-### Setup AWS SQS using AWS services
-
-You'll need a fully working AWS CLI locally.
-
-Create an SQS Queue where message data is pushed to
+It prints the endpoint, region and keys as JSON; they match
`application.properties`. In another terminal:
```shell
-aws sqs create-queue --queue-name sqs-news --region eu-west-1
+camel run *
```
-Don't forget to specify the correct sqs queue name in the
`application.properties` file and adding correct credentials for AWS.
+The three orders in `orders/` are read once each (`noop: true` leaves the
files in place), so the run can be
+repeated. Stop the example with `ctrl` + `c` and LocalStack with `camel infra
stop aws`.
-## How to run
+### Against real AWS
-Then you can run this example using:
+Create the queue, or leave `auto-create-queue` on, and replace the LocalStack
lines in `application.properties`:
-```shell
-$ camel run application.properties http-to-aws-sqs.camel.yaml
+```properties
+camel.component.aws2-sqs.access-key=<your access key>
+camel.component.aws2-sqs.secret-key=<your secret key>
+camel.component.aws2-sqs.region=eu-west-1
+camel.component.aws2-sqs.override-endpoint=false
```
-Or run it even shorter:
-
-```shell
-$ camel run *
-```
+The routes do not change. A profile, `application-aws.properties` with `camel
run * --profile=aws`, keeps
+both configurations side by side, as the `properties-and-profiles` example
shows.
-## Developer Web Console
+## How it works
-You can enable the developer console via `--console` flag as show:
+- The `aws2-sqs` component is configured once, at component level, with
`camel.component.aws2-sqs.*` in
+ `application.properties`: keys, region, and for LocalStack
`override-endpoint` with the local URL. Both
+ endpoints then only name the queue, `aws2-sqs:shipments`.
+- `hand-over` reads each order file and sends its text as the message body;
the order id goes in a header
+ for the log. `auto-create-queue` creates `shipments` on first use.
+- `courier` polls the queue, deletes each message after the route has handled
it, parses the JSON and logs it.
+ In real life the courier's system would be the consumer, and the shop only
the producer.
-```shell
-$ camel run application.properties http-to-aws-sqs.camel.yaml --console
-```
+## Build it step by step
-Then you can browse: http://localhost:8080/q/dev to introspect the running
Camel application.
+1. A `file` route on `orders` sending to `aws2-sqs:shipments`, with the
component properties; start LocalStack
+ and see the three messages go.
+2. Add the consumer route with a log of `${body}`.
+3. Parse the JSON and log the country and line count.
+4. Switch the properties to a real account and run again.
-## Create requests and push data to SQS
+## Try changing
-While the integration is running you can run the following commands:
-
-```shell
-curl -H "Content-Type: text/plain" -d 'Camel rocks!' http://localhost:8080/news
-```
-
-You will see the message content being processed and the AWS SQS queue should
receive a new message with the respective content.
+- Stop the example, run it again: nothing new arrives, the queue was emptied.
Then set `deleteAfterRead: false`
+ on the consumer and see the same orders come back after the visibility
timeout.
+- Add `delaySeconds: 10` on the producer endpoint and watch the courier wait.
+- Send an order from the CLI: `camel cmd send --endpoint=aws2-sqs:shipments
--body=@orders/order-1001.json`.
## Integration testing
-The example provides an automated integration test
(`http-to-aws-sqs.citrus.it.yaml`) in the
[Citrus](https://citrusframework.org/) YAML DSL, which the Camel CLI runs (the
test plugin installs on first use).
-
-You can run the test with:
+The example comes with a test in the [Citrus](https://citrusframework.org/)
YAML DSL,
+`test/aws-sqs.citrus.it.yaml`, which the Camel CLI runs. The test starts
LocalStack itself with the same
+`camel infra` mechanism, so nothing must be running beforehand:
```shell
-camel test run test/http-to-aws-sqs.citrus.it.yaml
+camel test run test/aws-sqs.citrus.it.yaml
```
-The test prepares the complete infrastructure and starts the Camel route
automatically.
-The Citrus test starts a Localstack Testcontainers instance to simulate the
AWS SQS services.
-Once the AWS services are configured the test loads the Camel route and
creates a proper Http POST request.
-As a result you will see the SQS data being consumed by the test to verify the
event processing.
+The test starts SQS, runs the routes and verifies that the courier picked up
all three orders.
## Help and contributions
diff --git a/cloud/aws-sqs/application.properties
b/cloud/aws-sqs/application.properties
index 62e8763..765f03d 100644
--- a/cloud/aws-sqs/application.properties
+++ b/cloud/aws-sqs/application.properties
@@ -1,21 +1,25 @@
+# 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
#
-# 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.
+# 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.
-aws.queueNameOrArn=sqs-news
-aws.secretKey=<secret_key>
-aws.accessKey=<access_key>
-aws.region=eu-west-1
+# LocalStack as started by: camel infra run aws sqs
+camel.component.aws2-sqs.access-key=accesskey
+camel.component.aws2-sqs.secret-key=secretkey
+camel.component.aws2-sqs.region=us-east-1
+camel.component.aws2-sqs.override-endpoint=true
+camel.component.aws2-sqs.uri-endpoint-override=http://localhost:4566
+# the queue is created on first use; on real AWS create it first, or keep this
+camel.component.aws2-sqs.auto-create-queue=true
diff --git a/cloud/aws-sqs/aws-sqs.camel.yaml b/cloud/aws-sqs/aws-sqs.camel.yaml
new file mode 100644
index 0000000..82be402
--- /dev/null
+++ b/cloud/aws-sqs/aws-sqs.camel.yaml
@@ -0,0 +1,36 @@
+# Shipments are handed to the courier through an Amazon SQS queue: the shop
+# puts each order on the queue, the courier's system takes it off. Locally
+# the queue lives on LocalStack, started with: camel infra run aws sqs
+- route:
+ id: hand-over
+ from:
+ uri: file
+ parameters:
+ directoryName: orders
+ noop: true
+ sortBy: "file:name"
+ steps:
+ - setHeader:
+ name: orderId
+ expression:
+ jsonpath:
+ expression: "$.orderId"
+ - to:
+ uri: aws2-sqs
+ parameters:
+ queueNameOrArn: shipments
+ - log:
+ message: "Order ${header.orderId} handed over on the shipments
queue"
+
+- route:
+ id: courier
+ from:
+ uri: aws2-sqs
+ parameters:
+ queueNameOrArn: shipments
+ steps:
+ - unmarshal:
+ json:
+ library: Jackson
+ - log:
+ message: "Courier picked up ${body[orderId]} for ${body[country]}:
${body[lines].size()} line(s)"
diff --git a/cloud/aws-sqs/http-to-aws-sqs.camel.yaml
b/cloud/aws-sqs/http-to-aws-sqs.camel.yaml
deleted file mode 100644
index a0998da..0000000
--- a/cloud/aws-sqs/http-to-aws-sqs.camel.yaml
+++ /dev/null
@@ -1,33 +0,0 @@
-## ---------------------------------------------------------------------------
-## 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.
-## ---------------------------------------------------------------------------
-
-- route:
- from:
- uri: platform-http:/news
- parameters:
- httpMethodRestrict: POST
- steps:
- - to:
- uri: "kamelet:aws-sqs-sink"
- parameters:
- queueNameOrArn: "{{aws.queueNameOrArn}}"
- accessKey: "{{aws.accessKey}}"
- secretKey: "{{aws.secretKey}}"
- region: "{{aws.region}}"
- overrideEndpoint: "{{aws.overrideEndpoint:false}}"
- uriEndpointOverride: "{{aws.uriEndpointOverride:none}}"
- autoCreateQueue: "{{aws.autoCreateQueue:false}}"
diff --git a/cloud/aws-sqs/metadata.json b/cloud/aws-sqs/metadata.json
index 3f07dc1..cbd33f1 100644
--- a/cloud/aws-sqs/metadata.json
+++ b/cloud/aws-sqs/metadata.json
@@ -1,18 +1,35 @@
{
- "title": "AWS SQS Sink",
- "description": "A POST to /news on port 8080 pushes the request body as a
message to an AWS SQS queue through the aws-sqs-sink Kamelet; credentials,
region and queue come from application.properties.",
+ "title": "AWS SQS",
+ "description": "Each of the three orders is put on an Amazon SQS queue
called shipments and a courier route takes it off and logs the order, country
and line count; locally the queue lives on the LocalStack that camel infra run
aws sqs starts, and the same properties point at real AWS.",
"level": "cloud",
"teaches": {
"components": [
- "platform-http",
- "kamelet"
+ "aws2-sqs",
+ "file",
+ "log"
+ ],
+ "eips": [
+ "setHeader",
+ "unmarshal"
+ ],
+ "languages": [
+ "simple",
+ "jsonpath"
+ ],
+ "dataformats": [
+ "json"
]
},
"tags": [
+ "shop",
"aws",
"sqs",
- "http",
- "cloud"
+ "cloud",
+ "messaging"
],
+ "infraServices": [
+ "aws"
+ ],
+ "requiresDocker": true,
"bundled": false
}
diff --git a/cloud/aws-sqs/orders/order-1001.json
b/cloud/aws-sqs/orders/order-1001.json
new file mode 100644
index 0000000..3eb5f03
--- /dev/null
+++ b/cloud/aws-sqs/orders/order-1001.json
@@ -0,0 +1,2 @@
+{"orderId": "ORD-1001", "customer": "C-482", "country": "DK", "status": "paid",
+ "lines": [{"sku": "CAMEL-TSHIRT", "qty": 2, "price": 19.95}, {"sku":
"CAMEL-MUG", "qty": 1, "price": 9.50}]}
diff --git a/cloud/aws-sqs/orders/order-1002.json
b/cloud/aws-sqs/orders/order-1002.json
new file mode 100644
index 0000000..bb7aa0e
--- /dev/null
+++ b/cloud/aws-sqs/orders/order-1002.json
@@ -0,0 +1,2 @@
+{"orderId": "ORD-1002", "customer": "C-207", "country": "DE", "status": "paid",
+ "lines": [{"sku": "CAMEL-MUG", "qty": 3, "price": 9.50}]}
diff --git a/cloud/aws-sqs/orders/order-1003.json
b/cloud/aws-sqs/orders/order-1003.json
new file mode 100644
index 0000000..9edab76
--- /dev/null
+++ b/cloud/aws-sqs/orders/order-1003.json
@@ -0,0 +1,2 @@
+{"orderId": "ORD-1003", "customer": "C-134", "country": "US", "status":
"pending",
+ "lines": [{"sku": "CAMEL-TSHIRT", "qty": 1, "price": 19.95}, {"sku":
"CAMEL-CAP", "qty": 1, "price": 14.00}, {"sku": "CAMEL-MUG", "qty": 2, "price":
9.50}]}
diff --git a/cloud/aws-sqs/test/application.test.properties
b/cloud/aws-sqs/test/application.test.properties
deleted file mode 100644
index eb02e13..0000000
--- a/cloud/aws-sqs/test/application.test.properties
+++ /dev/null
@@ -1,23 +0,0 @@
-#
-# 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.
-#
-
-aws.queueNameOrArn=${aws.sqs.queueName}
-aws.secretKey=${CITRUS_TESTCONTAINERS_LOCALSTACK_SECRET_KEY}
-aws.accessKey=${CITRUS_TESTCONTAINERS_LOCALSTACK_ACCESS_KEY}
-aws.region=${CITRUS_TESTCONTAINERS_LOCALSTACK_REGION}
-aws.overrideEndpoint=true
-aws.uriEndpointOverride=${CITRUS_TESTCONTAINERS_LOCALSTACK_SERVICE_URL}
diff --git a/cloud/aws-sqs/test/aws-sqs.citrus.it.yaml
b/cloud/aws-sqs/test/aws-sqs.citrus.it.yaml
new file mode 100644
index 0000000..84f49d0
--- /dev/null
+++ b/cloud/aws-sqs/test/aws-sqs.citrus.it.yaml
@@ -0,0 +1,45 @@
+# deps: software.amazon.awssdk:sqs:2.50.2
+name: aws-sqs-test
+description: The courier picks up every order from the shipments queue
+actions:
+ # LocalStack with SQS, started by Citrus; the properties file would win over
+ # inline properties, so the connection settings are all given here
+ - testcontainers:
+ start:
+ localstack:
+ services:
+ - "SQS"
+ - camel:
+ jbang:
+ run:
+ integration:
+ name: "aws-sqs"
+ file: "../aws-sqs.camel.yaml"
+ systemProperties:
+ properties:
+ - name: camel.component.aws2-sqs.access-key
+ value: "${CITRUS_TESTCONTAINERS_LOCALSTACK_ACCESS_KEY}"
+ - name: camel.component.aws2-sqs.secret-key
+ value: "${CITRUS_TESTCONTAINERS_LOCALSTACK_SECRET_KEY}"
+ - name: camel.component.aws2-sqs.region
+ value: "${CITRUS_TESTCONTAINERS_LOCALSTACK_REGION}"
+ - name: camel.component.aws2-sqs.override-endpoint
+ value: "true"
+ - name: camel.component.aws2-sqs.uri-endpoint-override
+ value: "${CITRUS_TESTCONTAINERS_LOCALSTACK_SERVICE_URL}"
+ - name: camel.component.aws2-sqs.auto-create-queue
+ value: "true"
+ resources:
+ - "orders/order-1001.json"
+ - "orders/order-1002.json"
+ - "orders/order-1003.json"
+ - camel:
+ jbang:
+ verify:
+ integration: "aws-sqs"
+ logMessage: "Order ORD-1003 handed over on the shipments queue"
+ - camel:
+ jbang:
+ verify:
+ integration: "aws-sqs"
+ logMessage: "Courier picked up ORD-1003 for US: 3 line(s)"
diff --git a/cloud/aws-sqs/test/citrus-application.properties
b/cloud/aws-sqs/test/citrus-application.properties
deleted file mode 100644
index 67a108f..0000000
--- a/cloud/aws-sqs/test/citrus-application.properties
+++ /dev/null
@@ -1,2 +0,0 @@
-# Enable dump of Camel JBang integration output
-citrus.camel.jbang.dump.integration.output=true
diff --git a/cloud/aws-sqs/test/http-to-aws-sqs.citrus.it.yaml
b/cloud/aws-sqs/test/http-to-aws-sqs.citrus.it.yaml
deleted file mode 100644
index 7d09cfb..0000000
--- a/cloud/aws-sqs/test/http-to-aws-sqs.citrus.it.yaml
+++ /dev/null
@@ -1,42 +0,0 @@
-name: http-to-aws-sqs
-description: Sample test in YAML
-variables:
- - name: "aws.sqs.queueName"
- value: sqs-news
- - name: "news.message"
- value: "Camel rocks!"
-actions:
- - testcontainers:
- start:
- localstack:
- services:
- - "SQS"
- options:
- queues: "${aws.sqs.queueName}"
- - camel:
- jbang:
- run:
- integration:
- name: "http-to-aws-sqs"
- file: "../http-to-aws-sqs.camel.yaml"
- systemProperties:
- file: "application.test.properties"
- - http:
- client: "http://localhost:8080";
- sendRequest:
- POST:
- path: "/news"
- contentType: "text/plain; charset=UTF-8"
- body:
- data: "${news.message}"
- - http:
- client: "http://localhost:8080";
- receiveResponse:
- response:
- status: 200
- - receive:
- endpoint: >-
- camel:aws2-sqs:${aws.sqs.queueName}?amazonSQSClient=#sqsClient
- message:
- body:
- data: "${news.message}"
