Story-Logging ---> Staging

.dockerignore

@@ -54,9 +54,3 @@
 **/__archive__*
 **/__pycache__*
 /build
-
-# ----------------------------------------------------------------
-# FORCE RETAIN
-# ----------------------------------------------------------------
-
-!**/.gitkeep

README.md

@@ -11,7 +11,7 @@
 
 # Example Rabbit MQ #
 
-This repository provides an example implementation of a tool with a single feature `SEARCH-FILESYSTEM`,
+This repository provides an example implementation of a tool with a single feature `SEARCH-FS`,
 which upon performs the following:
 
 - given a request payload;
@@ -29,6 +29,10 @@ which upon performs the following:
 
 - [docker + CLI tools](https://docs.docker.com/engine/install)
 
+- (optional) [Postman](https://www.postman.com).
+    Cf. the [wiki](https://github.com/raj-open/example-rabbit-mq/wiki/Postman-Setup)
+    for an prepared environment + collection.
+
 NOTE: We primarily use Docker for local testing, in particular to spin up a Rabbit MQ server.
 
 ## Basic setup ##
@@ -192,6 +196,7 @@ Fill in `setup/requests.yaml` as follows:
 label: 'Mock example'
 
 options:
+  reset-queue: true # default is false - whether to clear (sub)queue for task at start of run
   # skip-empty: true # false (default) => includes empty files; true => skips them
   max-depth: 100 # limits depth of folder structure
   max-items: 1_000_000 # limits number of items that can be logged

demo/README.md

@@ -25,14 +25,44 @@ For ease of use one can also run the demos as follows:
 
     where `{name}` is the name of the subfolder, e.g. `"example-case-1"`.
 
-> [!TIP]
-> Call
->
-> ```bash
-> just demo "example-all"
-> ```
->
-> to run all the examples.
+    > [!TIP]
+    > Call one of
+    >
+    > ```bash
+    > just demo "example-all"
+    > just demos # equivalent command
+    > ```
+    >
+    > to run all the examples.
+
+## Alternative via FastApi ##
+
+In step 2 one can alternatively start the FastApi server
+(via `just start-server` or `just docker-start-server`)
+and send a POST-request to the endpoing `/feature/search-fs`
+with JSON-body e.g.
+
+```json
+{
+    "ref": {
+      "location": "OS",
+      "path": "demo/example-case-1/requests.yaml"
+    }
+}
+```
+
+to run `SEARCH-FS` against `example-case-1` or
+
+```json
+{
+    "ref": {
+      "location": "OS",
+      "path": "demo/example-all/requests.yaml"
+    }
+}
+```
+
+to run `SEARCH-FS` against all cases.
 
 ## Results ##
 

demo/example-case-1/requests.yaml

@@ -1,6 +1,7 @@
 label: 'Demo Case 1'
 
 options:
+  reset-queue: true
   skip-empty: true
   max-depth: 100
   max-items: 10_000_000

demo/example-case-2/requests.yaml

@@ -1,6 +1,7 @@
 label: 'Demo Case 2'
 
 options:
+  reset-queue: true
   skip-empty: false
   max-depth: 100
   max-items: 10_000_000

demo/example-case-3/requests.yaml

@@ -1,6 +1,7 @@
 label: 'Demo Case 3'
 
 options:
+  reset-queue: true
   skip-empty: true
   max-depth: 100
   max-items: 10_000_000

demo/example-case-4/requests.yaml

@@ -1,6 +1,7 @@
 label: 'Demo Case 4'
 
 options:
+  reset-queue: true
   skip-empty: false
   max-depth: 100
   max-items: 10_000_000

demo/example-empty/requests.yaml

@@ -1,6 +1,7 @@
 label: 'Demo Empty'
 
 options:
+  reset-queue: true
   skip-empty: true
   max-depth: 100
   max-items: 10_000_000

demo/example-flat/requests.yaml

@@ -1,6 +1,7 @@
 label: 'Demo Flat'
 
 options:
+  reset-queue: true
   skip-empty: true
   max-depth: 100
   max-items: 10_000_000

docker-compose.yaml

@@ -17,7 +17,7 @@ secrets:
 
 services:
   # --------------------------------
-  # SERVICE: builds container
+  # SERVICES: main code base
   # --------------------------------
 
   base:
@@ -44,10 +44,6 @@ services:
     stdin_open: true
     user: root
 
-  # --------------------------------
-  # SERVICE: builds container
-  # --------------------------------
-
   build:
     image: local/examplerabbitmq:build
 
@@ -70,10 +66,6 @@ services:
         echo "success"
       '
 
-  # --------------------------------
-  # SERVICE: runs qa steps
-  # --------------------------------
-
   qa:
     image: local/examplerabbitmq:build # <- i.e. use this image
     env_file:
@@ -93,7 +85,7 @@ services:
       '
 
   # --------------------------------
-  # SERVICE: starts server
+  # SERVICES: server
   # --------------------------------
 
   server:
@@ -111,16 +103,18 @@ services:
       - type: bind
         source: ${PATH_LOGS}
         target: //home/basicuser/app/logs
-      - ./setup://home/basicuser/app/setup:ro
+      - ./demo://home/basicuser/app/demo:ro
       - ./data://home/basicuser/app/data:rw
+      - ./setup://home/basicuser/app/setup:ro
 
     # # for debugging
     # volumes:
     #   - type: bind
     #     source: ${PATH_LOGS}
     #     target: //home/basicuser/app/logs
-    #   - ./setup://home/basicuser/app/setup:ro
+    #   - ./demo://home/basicuser/app/demo:ro
     #   - ./data://home/basicuser/app/data:rw
+    #   - ./setup://home/basicuser/app/setup:ro
     #   - ./scripts://home/basicuser/app/scripts:ro
     #   - ./src://home/basicuser/app/src:ro
     #   - ./tests://home/basicuser/app/tests:ro
@@ -160,7 +154,7 @@ services:
       '
 
   # --------------------------------
-  # SERVICE: queue
+  # SERVICES: queue
   # --------------------------------
 
   queue-build:

docs/models/application/Models/RequestTaskOptions.md

@@ -3,6 +3,7 @@
 
 | Name | Type | Description | Notes |
 |------------ | ------------- | ------------- | -------------|
+| **reset-queue** | **Boolean** | Whether to clear queue before execution | [optional] [default to false] |
 | **skip-empty** | **Boolean** | Whether to only include non-empty files | [optional] [default to false] |
 | **max-depth** | **Integer** | Limits the search depth | [optional] [default to 50] |
 | **max-items** | **Integer** | Limits the amount of items that can be found | [optional] [default to 1000000] |

justfile

@@ -300,6 +300,9 @@ create-mocks *args:
 demo name:
     @just run SEARCH-FS --requests "demo/{{name}}/requests.yaml"
 
+demos:
+    @just demo "example-all"
+
 # --------------------------------
 # TARGETS: terminate execution
 # --------------------------------

models/schema-application.yaml

@@ -151,6 +151,11 @@ components:
         - max-duration
       additionalProperties: true
       properties:
+        reset-queue:
+          description: |-
+            Whether to clear queue before execution
+          type: boolean
+          default: false
         skip-empty:
           description: |-
             Whether to only include non-empty files