Added support for Kinesis

README.md

@@ -14,6 +14,8 @@ At the moment, this library provides the following:
 * `KMS`: allows to list KMS keys and generate a unique symmetric data key for use outside of AWS KMS
 * `SSM`: allows to retrieve a parameter from AWS Systems Manager
 * `V4 signature`: allows to sign requests to amazon AWS services
+* `KinesisClient`: allows all APIs for Kinesis available by AWS.
+
 
 ## Want to contribute?
 
@@ -256,6 +258,52 @@ export default function () {
 }
 ```
 
+
+### Kinesis
+
+Consult the `KinesisClient` [dedicated k6 documentation page](https://k6.io/docs/javascript-api/jslib/aws/kinesisclient) for more details on its methods and how to use it.
+
+```javascript
+import exec from 'k6/execution'
+
+import { AWSConfig, KinesisClient } from 'https://jslib.k6.io/aws/0.7.0/kinesis.js'
+import encoding from 'k6/encoding';
+import { describe, expect } from 'https://jslib.k6.io/k6chaijs/4.3.4.2/index.js';
+import { fail } from 'k6';
+
+const awsConfig = new AWSConfig({
+    region: __ENV.AWS_REGION,
+    accessKeyId: __ENV.AWS_ACCESS_KEY_ID,
+    secretAccessKey: __ENV.AWS_SECRET_ACCESS_KEY,
+    sessionToken: __ENV.AWS_SESSION_TOKEN,
+})
+const kinesis = new KinesisClient(awsConfig)
+
+export default function () {
+    describe('01. List Kinesis streams', () => {
+        try {
+            const res = kinesis.listStreams()
+            expect(res.StreamNames.length,"number of streams").to.equal(6);
+        } catch(err) {
+            fail(err)
+        }
+
+    })
+
+    describe('02. List kinesis stream with arguments', () => {
+        try {
+            const res = kinesis.listStreams({Limit: 1})
+            expect(res.StreamNames.length,"number of streams").to.equal(1);
+        } catch(err) {
+            fail(err)
+        }
+    })
+}
+
+```
+
+
+
 ## Development
 
 ### Contributing

docker-compose.yml

@@ -8,7 +8,7 @@ services:
       - "127.0.0.1:4566:4566"            # LocalStack Gateway
       - "127.0.0.1:4510-4559:4510-4559"  # external services port range
     environment:
-      - SERVICES=s3,secretsmanager,sqs,kms,ssm
+      - SERVICES=s3,secretsmanager,sqs,kms,ssm,kinesis
       - DEFAULT_REGION=us-east-1
       - DEBUG=${DEBUG-}
       - PERSISTENCE=${PERSISTENCE-}

examples/kinesis.js

@@ -0,0 +1,128 @@
+import exec from 'k6/execution'
+
+import { AWSConfig, KinesisClient } from '../build/kinesis.js'
+import encoding from 'k6/encoding';
+import { describe, expect } from 'https://jslib.k6.io/k6chaijs/4.3.4.2/index.js';
+import { fail } from 'k6';
+
+const dummyStream = `kinesis-test-stream-provisioned`
+
+const awsConfig = new AWSConfig({
+    region: __ENV.AWS_REGION,
+    accessKeyId: __ENV.AWS_ACCESS_KEY_ID,
+    secretAccessKey: __ENV.AWS_SECRET_ACCESS_KEY,
+    sessionToken: __ENV.AWS_SESSION_TOKEN,
+})
+const kinesis = new KinesisClient(awsConfig)
+
+const getShardIds = () => {
+    const res = kinesis.listShards({
+        StreamName: dummyStream,
+    })
+    const shardIds = res.Shards.map(shard => shard.ShardId);
+
+    return shardIds
+}
+
+const getShardIterator = (shardId) => {
+    const res = kinesis.getShardIterator({
+        StreamName: dummyStream,
+        ShardId: shardId,
+        ShardIteratorType: `TRIM_HORIZON`
+    })
+    return res.ShardIterator
+}
+
+export default function () {
+    describe('01. Create kinesis Stream', () => {
+        try {
+            // Valid Values: PROVISIONED | ON_DEMAND
+            kinesis.createStream({
+
+                "ShardCount": 10,
+                "StreamModeDetails": {
+                    "StreamMode": "PROVISIONED"
+                },
+                "StreamName": dummyStream
+
+            })
+        } catch (err) {
+            fail(err)
+        }
+    })
+
+    describe('02. List Kinesis streams', () => {
+        try {
+            const res = kinesis.listStreams()
+            expect(res.StreamNames.length, "number of streams").to.equal(1);
+        } catch (err) {
+            fail(err)
+        }
+    })
+
+
+    describe('03. List kinesis stream with arguments', () => {
+        try {
+            const res = kinesis.listStreams({ Limit: 1 })
+            expect(res.StreamNames.length, "number of streams").to.equal(1);
+        } catch (err) {
+            fail(err)
+        }
+        sleep(2)
+    })
+
+
+    describe('04. publish to kinesis Stream', () => {
+        try {
+            for (let i = 0; i < 50; i++) {
+                const res = kinesis.putRecords({
+                    StreamName: dummyStream,
+                    Records: [
+                        {
+                            Data: encoding.b64encode(JSON.stringify({ 'this': 'is', 'a': 'test' })),
+                            PartitionKey: "partitionKey1"
+                        },
+                        {
+                            Data: encoding.b64encode(JSON.stringify([{ 'this': 'is', 'second': 'test' }])),
+                            PartitionKey: "partitionKey2"
+                        }
+                    ]
+                })
+                expect(res.FailedRecordCount, `Failed Records to publish`).to.equal(0);
+                expect(res.Records.length, `Total Records`).to.equal(2);
+            }
+        } catch (err) {
+            fail(err)
+        }
+    })
+
+
+
+    describe('05. Gets an Amazon Kinesis read all data ', () => {
+        try {
+            const shards = getShardIds()
+            shards.map(shard => {
+                let iterator = getShardIterator(shard)
+                while (true) {
+                    const res = kinesis.getRecords({ ShardIterator: iterator })
+                    iterator = res.NextShardIterator
+
+                    if (!res.MillisBehindLatest || res.MillisBehindLatest == `0`) {
+                        break
+                    }
+                }
+            })
+        } catch (err) {
+            fail(err)
+        }
+    })
+
+
+    describe('06. Delete kinesis Stream', () => {
+        try {
+            kinesis.deleteStream({ StreamName: dummyStream })
+        } catch (err) {
+            fail(err)
+        }
+    })
+}

src/index.ts

@@ -17,6 +17,7 @@ import {
     SystemsManagerParameter,
     SystemsManagerServiceError,
 } from './internal/ssm'
+import { KinesisClient } from './internal/kinesis'
 
 // Re-Export public symbols
 export {
@@ -45,4 +46,6 @@ export {
     SystemsManagerClient,
     SystemsManagerParameter,
     SystemsManagerServiceError,
+    // Kinesis
+    KinesisClient
 }