diff --git a/docs/examples/index.md b/docs/examples/index.md index 9ee87b1a..534e430a 100644 --- a/docs/examples/index.md +++ b/docs/examples/index.md @@ -14,3 +14,9 @@ SPDX-License-Identifier: CC-BY-NC-SA-4.0 + + + + + + diff --git a/docs/examples/pocketbase/create_record.data b/docs/examples/pocketbase/create_record.data new file mode 100644 index 00000000..a97013dc --- /dev/null +++ b/docs/examples/pocketbase/create_record.data @@ -0,0 +1,11 @@ +{ + "create_parameters": { + "collection": "organizations", + "record": { + "name": "Jhon org" + } + }, + "record_parameters": { + "requestKey": "testCreate" + } +} diff --git a/docs/examples/pocketbase/create_record.keys b/docs/examples/pocketbase/create_record.keys new file mode 100644 index 00000000..8182adf4 --- /dev/null +++ b/docs/examples/pocketbase/create_record.keys @@ -0,0 +1,7 @@ +{ + "pb_address": "http://127.0.0.1:8090", + "my_credentials": { + "email": "test@test.eu", + "password": "testtest" + } +} diff --git a/docs/examples/pocketbase/create_record.zen b/docs/examples/pocketbase/create_record.zen new file mode 100644 index 00000000..764220e8 --- /dev/null +++ b/docs/examples/pocketbase/create_record.zen @@ -0,0 +1,9 @@ +Rule unknown ignore + +Given I connect to 'pb_address' and start pb client +Given I send my_credentials 'my_credentials' and login + +Given I send create_parameters 'create_parameters' and send record_parameters 'record_parameters' and create record and output into 'result' + +Given I have a 'string dictionary' named 'result' +Then print the 'result' diff --git a/docs/examples/pocketbase/delete_record.data b/docs/examples/pocketbase/delete_record.data new file mode 100644 index 00000000..7d5ba137 --- /dev/null +++ b/docs/examples/pocketbase/delete_record.data @@ -0,0 +1,6 @@ +{ + "delete_parameters": { + "collection": "organizations", + "id": "q3vijjsacrn32tk" + } +} diff --git a/docs/examples/pocketbase/delete_record.keys b/docs/examples/pocketbase/delete_record.keys new file mode 100644 index 00000000..8182adf4 --- /dev/null +++ b/docs/examples/pocketbase/delete_record.keys @@ -0,0 +1,7 @@ +{ + "pb_address": "http://127.0.0.1:8090", + "my_credentials": { + "email": "test@test.eu", + "password": "testtest" + } +} diff --git a/docs/examples/pocketbase/delete_record.zen b/docs/examples/pocketbase/delete_record.zen new file mode 100644 index 00000000..e640de87 --- /dev/null +++ b/docs/examples/pocketbase/delete_record.zen @@ -0,0 +1,9 @@ +Rule unknown ignore + +Given I connect to 'pb_address' and start pb client +Given I send my_credentials 'my_credentials' and login + +Given I send delete_parameters 'delete_parameters' and delete record and output into 'result' + +Given I have a 'string' named 'result' +Then print the 'result' diff --git a/docs/examples/pocketbase/get_one_record.data b/docs/examples/pocketbase/get_one_record.data new file mode 100644 index 00000000..1e5aeba9 --- /dev/null +++ b/docs/examples/pocketbase/get_one_record.data @@ -0,0 +1,7 @@ +{ + "show_parameters": { + "collection": "organizations", + "id": "p7viyzsihrn52uj", + "fields": "name" + } +} diff --git a/docs/examples/pocketbase/get_one_record.keys b/docs/examples/pocketbase/get_one_record.keys new file mode 100644 index 00000000..95669c91 --- /dev/null +++ b/docs/examples/pocketbase/get_one_record.keys @@ -0,0 +1,3 @@ +{ + "pb_address": "http://127.0.0.1:8090" +} diff --git a/docs/examples/pocketbase/get_one_record.zen b/docs/examples/pocketbase/get_one_record.zen new file mode 100644 index 00000000..312cab10 --- /dev/null +++ b/docs/examples/pocketbase/get_one_record.zen @@ -0,0 +1,8 @@ +Rule unknown ignore + +Given I connect to 'pb_address' and start pb client + +Given I send show_parameters 'show_parameters' and get one record and output into 'result' + +Given I have a 'string dictionary' named 'result' +Then print the 'result' diff --git a/docs/examples/pocketbase/get_some_records.data b/docs/examples/pocketbase/get_some_records.data new file mode 100644 index 00000000..7a53624f --- /dev/null +++ b/docs/examples/pocketbase/get_some_records.data @@ -0,0 +1,10 @@ +{ + "list_parameters": { + "type": "list", + "pagination": { + "page": 2, + "perPage": 20 + }, + "collection": "organizations" + } +} diff --git a/docs/examples/pocketbase/get_some_records.keys b/docs/examples/pocketbase/get_some_records.keys new file mode 100644 index 00000000..95669c91 --- /dev/null +++ b/docs/examples/pocketbase/get_some_records.keys @@ -0,0 +1,3 @@ +{ + "pb_address": "http://127.0.0.1:8090" +} diff --git a/docs/examples/pocketbase/get_some_records.zen b/docs/examples/pocketbase/get_some_records.zen new file mode 100644 index 00000000..cba8ba9b --- /dev/null +++ b/docs/examples/pocketbase/get_some_records.zen @@ -0,0 +1,8 @@ +Rule unknown ignore + +Given I connect to 'pb_address' and start pb client + +Given I send list_parameters 'list_parameters' and get some records and output into 'result' + +Given I have a 'string dictionary' named 'result' +Then print the 'result' diff --git a/docs/examples/pocketbase/index.md b/docs/examples/pocketbase/index.md new file mode 100644 index 00000000..28c92a50 --- /dev/null +++ b/docs/examples/pocketbase/index.md @@ -0,0 +1,70 @@ + + +## pocketbase plugin examples + +### start pb client +::: code-group +<<< @/examples/pocketbase/start_pb.zen{3 gherkin:line-numbers} +<<< @/examples/pocketbase/start_pb.data{json} +<<< @/examples/pocketbase/start_pb.keys{json} +::: + +### login +::: code-group +<<< @/examples/pocketbase/login.zen{5 gherkin:line-numbers} +<<< @/examples/pocketbase/login.data{json} +<<< @/examples/pocketbase/login.keys{json} +::: + +### password reset +::: code-group +<<< @/examples/pocketbase/pw_reset.zen{6 gherkin:line-numbers} +<<< @/examples/pocketbase/pw_reset.data{json} +<<< @/examples/pocketbase/pw_reset.keys{json} +::: + +### get some records +::: code-group +<<< @/examples/pocketbase/get_some_records.zen{5 gherkin:line-numbers} +<<< @/examples/pocketbase/get_some_records.data{json} +<<< @/examples/pocketbase/get_some_records.keys{json} +::: + +### get one record +::: code-group +<<< @/examples/pocketbase/get_one_record.zen{5 gherkin:line-numbers} +<<< @/examples/pocketbase/get_one_record.data{json} +<<< @/examples/pocketbase/get_one_record.keys{json} +::: + +### create a record +::: code-group +<<< @/examples/pocketbase/create_record.zen{6 gherkin:line-numbers} +<<< @/examples/pocketbase/create_record.data{json} +<<< @/examples/pocketbase/create_record.keys{json} +::: + +### update a record +::: code-group +<<< @/examples/pocketbase/update_record.zen{6 gherkin:line-numbers} +<<< @/examples/pocketbase/update_record.data{json} +<<< @/examples/pocketbase/update_record.keys{json} +::: + +### delete a record +::: code-group +<<< @/examples/pocketbase/delete_record.zen{6 gherkin:line-numbers} +<<< @/examples/pocketbase/delete_record.data{json} +<<< @/examples/pocketbase/delete_record.keys{json} +::: + +### send request +::: code-group +<<< @/examples/pocketbase/send_request.zen{5 gherkin:line-numbers} +<<< @/examples/pocketbase/send_request.data{json} +<<< @/examples/pocketbase/send_request.keys{json} +::: diff --git a/docs/examples/pocketbase/login.data b/docs/examples/pocketbase/login.data new file mode 100644 index 00000000..3bbabe0d --- /dev/null +++ b/docs/examples/pocketbase/login.data @@ -0,0 +1,6 @@ +{ + "my_credentials": { + "email": "test@test.eu", + "password": "testtest" + } +} diff --git a/docs/examples/pocketbase/login.keys b/docs/examples/pocketbase/login.keys new file mode 100644 index 00000000..95669c91 --- /dev/null +++ b/docs/examples/pocketbase/login.keys @@ -0,0 +1,3 @@ +{ + "pb_address": "http://127.0.0.1:8090" +} diff --git a/docs/examples/pocketbase/login.zen b/docs/examples/pocketbase/login.zen new file mode 100644 index 00000000..fa091b40 --- /dev/null +++ b/docs/examples/pocketbase/login.zen @@ -0,0 +1,8 @@ +Rule unknown ignore + +Given I connect to 'pb_address' and start pb client + +Given I send my_credentials 'my_credentials' and login and output into 'result' + +Given I have a 'string' named 'result' +Then print the 'result' diff --git a/docs/examples/pocketbase/pw_reset.data b/docs/examples/pocketbase/pw_reset.data new file mode 100644 index 00000000..38591a40 --- /dev/null +++ b/docs/examples/pocketbase/pw_reset.data @@ -0,0 +1,3 @@ +{ + "email": "test@test.eu" +} diff --git a/docs/examples/pocketbase/pw_reset.keys b/docs/examples/pocketbase/pw_reset.keys new file mode 100644 index 00000000..8182adf4 --- /dev/null +++ b/docs/examples/pocketbase/pw_reset.keys @@ -0,0 +1,7 @@ +{ + "pb_address": "http://127.0.0.1:8090", + "my_credentials": { + "email": "test@test.eu", + "password": "testtest" + } +} diff --git a/docs/examples/pocketbase/pw_reset.zen b/docs/examples/pocketbase/pw_reset.zen new file mode 100644 index 00000000..2af6c0fe --- /dev/null +++ b/docs/examples/pocketbase/pw_reset.zen @@ -0,0 +1,9 @@ +Rule unknown ignore + +Given I connect to 'pb_address' and start pb client +Given I send my_credentials 'my_credentials' and login + +Given I send email 'email' and ask password reset and output into 'result' + +Given I have a 'string dictionary' named 'result' +Then print the 'result' diff --git a/docs/examples/pocketbase/send_request.data b/docs/examples/pocketbase/send_request.data new file mode 100644 index 00000000..ed8f476f --- /dev/null +++ b/docs/examples/pocketbase/send_request.data @@ -0,0 +1,4 @@ +{ + "url": "/api/hello/user", + "send_parameters": {} +} diff --git a/docs/examples/pocketbase/send_request.keys b/docs/examples/pocketbase/send_request.keys new file mode 100644 index 00000000..95669c91 --- /dev/null +++ b/docs/examples/pocketbase/send_request.keys @@ -0,0 +1,3 @@ +{ + "pb_address": "http://127.0.0.1:8090" +} diff --git a/docs/examples/pocketbase/send_request.zen b/docs/examples/pocketbase/send_request.zen new file mode 100644 index 00000000..2b84e1af --- /dev/null +++ b/docs/examples/pocketbase/send_request.zen @@ -0,0 +1,8 @@ +Rule unknown ignore + +Given I connect to 'pb_address' and start pb client + +Given I send url 'url' and send send_parameters 'send_parameters' and send request and output into 'result' + +Given I have a 'string dictionary' named 'result' +Then print the 'result' diff --git a/docs/examples/pocketbase/start_pb.data b/docs/examples/pocketbase/start_pb.data new file mode 100644 index 00000000..0967ef42 --- /dev/null +++ b/docs/examples/pocketbase/start_pb.data @@ -0,0 +1 @@ +{} diff --git a/docs/examples/pocketbase/start_pb.keys b/docs/examples/pocketbase/start_pb.keys new file mode 100644 index 00000000..95669c91 --- /dev/null +++ b/docs/examples/pocketbase/start_pb.keys @@ -0,0 +1,3 @@ +{ + "pb_address": "http://127.0.0.1:8090" +} diff --git a/docs/examples/pocketbase/start_pb.zen b/docs/examples/pocketbase/start_pb.zen new file mode 100644 index 00000000..385c2831 --- /dev/null +++ b/docs/examples/pocketbase/start_pb.zen @@ -0,0 +1,8 @@ +Rule unknown ignore + +Given I connect to 'pb_address' and start pb client and output into 'result' +# for mobile contracts use instead +# Given I connect to 'pb_address' and start capacitor pb client and output into 'result' + +Given I have a 'string' named 'result' +Then print the 'result' diff --git a/docs/examples/pocketbase/update_record.data b/docs/examples/pocketbase/update_record.data new file mode 100644 index 00000000..2ec9def3 --- /dev/null +++ b/docs/examples/pocketbase/update_record.data @@ -0,0 +1,12 @@ +{ + "update_parameters": { + "id": "q3vijjsacrn32tk", + "collection": "organizations", + "record": { + "name": "new value for name" + } + }, + "record_parameters": { + "fields": "id, name" + } +} diff --git a/docs/examples/pocketbase/update_record.keys b/docs/examples/pocketbase/update_record.keys new file mode 100644 index 00000000..8182adf4 --- /dev/null +++ b/docs/examples/pocketbase/update_record.keys @@ -0,0 +1,7 @@ +{ + "pb_address": "http://127.0.0.1:8090", + "my_credentials": { + "email": "test@test.eu", + "password": "testtest" + } +} diff --git a/docs/examples/pocketbase/update_record.zen b/docs/examples/pocketbase/update_record.zen new file mode 100644 index 00000000..2a165b55 --- /dev/null +++ b/docs/examples/pocketbase/update_record.zen @@ -0,0 +1,9 @@ +Rule unknown ignore + +Given I connect to 'pb_address' and start pb client +Given I send my_credentials 'my_credentials' and login + +Given I send update_parameters 'update_parameters' and send record_parameters 'record_parameters' and update record and output into 'result' + +Given I have a 'string dictionary' named 'result' +Then print the 'result' diff --git a/docs/examples/qrcode/index.md b/docs/examples/qrcode/index.md new file mode 100644 index 00000000..8638b6d9 --- /dev/null +++ b/docs/examples/qrcode/index.md @@ -0,0 +1,14 @@ + + +## qrcode plugin examples + +### create qr code +::: code-group +<<< @/examples/qrcode/qr_code.zen{3 gherkin:line-numbers} +<<< @/examples/qrcode/qr_code.data{json} +<<< @/examples/qrcode/qr_code.keys{json} +::: diff --git a/docs/examples/qrcode/qr_code.data b/docs/examples/qrcode/qr_code.data new file mode 100644 index 00000000..47bf399a --- /dev/null +++ b/docs/examples/qrcode/qr_code.data @@ -0,0 +1,3 @@ +{ + "text": "Hello World!" +} diff --git a/docs/examples/qrcode/qr_code.keys b/docs/examples/qrcode/qr_code.keys new file mode 100644 index 00000000..0967ef42 --- /dev/null +++ b/docs/examples/qrcode/qr_code.keys @@ -0,0 +1 @@ +{} diff --git a/docs/examples/qrcode/qr_code.zen b/docs/examples/qrcode/qr_code.zen new file mode 100644 index 00000000..c8e40f0a --- /dev/null +++ b/docs/examples/qrcode/qr_code.zen @@ -0,0 +1,6 @@ +Rule unknown ignore + +Given I send text 'text' and create qr code and output into 'result' + +Given I have a 'string' named 'result' +Then print the 'result' diff --git a/docs/examples/redis/delete.data b/docs/examples/redis/delete.data new file mode 100644 index 00000000..4869bf8d --- /dev/null +++ b/docs/examples/redis/delete.data @@ -0,0 +1,3 @@ +{ + "key": "some key" +} diff --git a/docs/examples/redis/delete.keys b/docs/examples/redis/delete.keys new file mode 100644 index 00000000..fe8ff570 --- /dev/null +++ b/docs/examples/redis/delete.keys @@ -0,0 +1,3 @@ +{ + "redis": "redis://localhost:6379" +} diff --git a/docs/examples/redis/delete.zen b/docs/examples/redis/delete.zen new file mode 100644 index 00000000..528037cd --- /dev/null +++ b/docs/examples/redis/delete.zen @@ -0,0 +1,6 @@ +Rule unknown ignore + +Given I connect to 'redis' and send key 'key' and delete key from redis and output into 'result' + +Given I have a 'number' named 'result' +Then print the 'result' diff --git a/docs/examples/redis/index.md b/docs/examples/redis/index.md new file mode 100644 index 00000000..1645095a --- /dev/null +++ b/docs/examples/redis/index.md @@ -0,0 +1,28 @@ + + +## redis plugin examples + +### write object into key in redis +::: code-group +<<< @/examples/redis/write.zen{3 gherkin:line-numbers} +<<< @/examples/redis/write.data{json} +<<< @/examples/redis/write.keys{json} +::: + +### read key from redis +::: code-group +<<< @/examples/redis/read.zen{3 gherkin:line-numbers} +<<< @/examples/redis/read.data{json} +<<< @/examples/redis/read.keys{json} +::: + +### delete key from redis +::: code-group +<<< @/examples/redis/delete.zen{3 gherkin:line-numbers} +<<< @/examples/redis/delete.data{json} +<<< @/examples/redis/delete.keys{json} +::: diff --git a/docs/examples/redis/read.data b/docs/examples/redis/read.data new file mode 100644 index 00000000..4869bf8d --- /dev/null +++ b/docs/examples/redis/read.data @@ -0,0 +1,3 @@ +{ + "key": "some key" +} diff --git a/docs/examples/redis/read.keys b/docs/examples/redis/read.keys new file mode 100644 index 00000000..fe8ff570 --- /dev/null +++ b/docs/examples/redis/read.keys @@ -0,0 +1,3 @@ +{ + "redis": "redis://localhost:6379" +} diff --git a/docs/examples/redis/read.zen b/docs/examples/redis/read.zen new file mode 100644 index 00000000..e846ccad --- /dev/null +++ b/docs/examples/redis/read.zen @@ -0,0 +1,6 @@ +Rule unknown ignore + +Given I connect to 'redis' and send key 'key' and read key from redis and output into 'result' + +Given I have a 'string dictionary' named 'result' +Then print the 'result' diff --git a/docs/examples/redis/write.data b/docs/examples/redis/write.data new file mode 100644 index 00000000..9752d330 --- /dev/null +++ b/docs/examples/redis/write.data @@ -0,0 +1,7 @@ +{ + "key": "some key", + "object": { + "foo": "bar", + "baz": "qux" + } +} diff --git a/docs/examples/redis/write.keys b/docs/examples/redis/write.keys new file mode 100644 index 00000000..fe8ff570 --- /dev/null +++ b/docs/examples/redis/write.keys @@ -0,0 +1,3 @@ +{ + "redis": "redis://localhost:6379" +} diff --git a/docs/examples/redis/write.zen b/docs/examples/redis/write.zen new file mode 100644 index 00000000..b8634f25 --- /dev/null +++ b/docs/examples/redis/write.zen @@ -0,0 +1,6 @@ +Rule unknown ignore + +Given I connect to 'redis' and send key 'key' and send object 'object' and write object into key in redis and outpuit into 'result' + +Given I have a 'string' named 'result' +Then print the 'result' diff --git a/docs/examples/shell/execute.data b/docs/examples/shell/execute.data new file mode 100644 index 00000000..351fb7fc --- /dev/null +++ b/docs/examples/shell/execute.data @@ -0,0 +1,3 @@ +{ + "command": "ls -a" +} diff --git a/docs/examples/shell/execute.keys b/docs/examples/shell/execute.keys new file mode 100644 index 00000000..0967ef42 --- /dev/null +++ b/docs/examples/shell/execute.keys @@ -0,0 +1 @@ +{} diff --git a/docs/examples/shell/execute.zen b/docs/examples/shell/execute.zen new file mode 100644 index 00000000..88e1ff9b --- /dev/null +++ b/docs/examples/shell/execute.zen @@ -0,0 +1,6 @@ +Rule unknown ignore + +Given I send command 'command' and execute in shell and output into 'result' + +Given I have a 'string' named 'result' +Then print the 'result' diff --git a/docs/examples/shell/index.md b/docs/examples/shell/index.md new file mode 100644 index 00000000..f0de7071 --- /dev/null +++ b/docs/examples/shell/index.md @@ -0,0 +1,14 @@ + + +## shell plugin examples + +### execute in shell +::: code-group +<<< @/examples/shell/execute.zen{3 gherkin:line-numbers} +<<< @/examples/shell/execute.data{json} +<<< @/examples/shell/execute.keys{json} +::: diff --git a/docs/examples/timestamp/fetch_timestamp.data b/docs/examples/timestamp/fetch_timestamp.data new file mode 100644 index 00000000..0967ef42 --- /dev/null +++ b/docs/examples/timestamp/fetch_timestamp.data @@ -0,0 +1 @@ +{} diff --git a/docs/examples/timestamp/fetch_timestamp.keys b/docs/examples/timestamp/fetch_timestamp.keys new file mode 100644 index 00000000..0967ef42 --- /dev/null +++ b/docs/examples/timestamp/fetch_timestamp.keys @@ -0,0 +1 @@ +{} diff --git a/docs/examples/timestamp/fetch_timestamp.zen b/docs/examples/timestamp/fetch_timestamp.zen new file mode 100644 index 00000000..7c046277 --- /dev/null +++ b/docs/examples/timestamp/fetch_timestamp.zen @@ -0,0 +1,9 @@ +Rule unknown ignore + +Given I fetch the local timestamp in seconds and output into 'result_in_seconds' +Given I fetch the local timestamp in milliseconds and output into 'result_in_milliseconds' + +Given I have a 'string' named 'result_in_seconds' +Given I have a 'string' named 'result_in_milliseconds' +Then print the 'result_in_seconds' +Then print the 'result_in_milliseconds' diff --git a/docs/examples/timestamp/index.md b/docs/examples/timestamp/index.md new file mode 100644 index 00000000..b0f48ecb --- /dev/null +++ b/docs/examples/timestamp/index.md @@ -0,0 +1,14 @@ + + +## timestamp plugin examples + +### fetch the local timestamp +::: code-group +<<< @/examples/timestamp/fetch_timestamp.zen{3-4 gherkin:line-numbers} +<<< @/examples/timestamp/fetch_timestamp.data{json} +<<< @/examples/timestamp/fetch_timestamp.keys{json} +::: diff --git a/docs/examples/zencode/execute_zencode.data b/docs/examples/zencode/execute_zencode.data new file mode 100644 index 00000000..0effb01c --- /dev/null +++ b/docs/examples/zencode/execute_zencode.data @@ -0,0 +1,7 @@ +{ + "keys": { + "keyring": { + "ecdh": "FJ5Esc1koLSH+9pKSdI65tcyH2HowzXMe0UdsqktmZU=" + } + } +} diff --git a/docs/examples/zencode/execute_zencode.keys b/docs/examples/zencode/execute_zencode.keys new file mode 100644 index 00000000..bef82baa --- /dev/null +++ b/docs/examples/zencode/execute_zencode.keys @@ -0,0 +1,4 @@ +{ + "zencode": "Scenario 'ecdh': Create the public key\nGiven I have the 'keyring'\nWhen I create the ecdh public key\nThen print the 'ecdh public key'\n", + "data": {} +} diff --git a/docs/examples/zencode/execute_zencode.zen b/docs/examples/zencode/execute_zencode.zen new file mode 100644 index 00000000..cea7aa5e --- /dev/null +++ b/docs/examples/zencode/execute_zencode.zen @@ -0,0 +1,6 @@ +Rule unknown ignore + +Given I send keys 'keys' and send data 'data' and send script 'script' and execute zencode and output into 'result' + +Given I have a 'string dictionary' named 'result' +Then print the 'result' diff --git a/docs/examples/zencode/index.md b/docs/examples/zencode/index.md new file mode 100644 index 00000000..54a51435 --- /dev/null +++ b/docs/examples/zencode/index.md @@ -0,0 +1,14 @@ + + +## zencode plugin examples + +### execute zencode +::: code-group +<<< @/examples/zencode/execute_zencode.zen{3 gherkin:line-numbers} +<<< @/examples/zencode/execute_zencode.data{json} +<<< @/examples/zencode/execute_zencode.keys{json} +:::