From 7ca4b7a9a8c7d2799891a7f709578e2426f480c2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tonon=20Gr=C3=A9gory?= Date: Tue, 3 Dec 2024 14:42:14 +0100 Subject: [PATCH 1/4] #12 Add description to each process --- config/packages/process/demo.debug.yaml | 2 ++ config/packages/process/demo.die.yaml | 2 ++ config/packages/process/demo.doctrine.read.yaml | 2 ++ config/packages/process/demo.logger.yaml | 2 ++ config/packages/process/demo.sample.yaml | 2 ++ config/packages/process/demo.upload_and_run.yaml | 2 ++ 6 files changed, 12 insertions(+) diff --git a/config/packages/process/demo.debug.yaml b/config/packages/process/demo.debug.yaml index 974bfb9..a095df3 100644 --- a/config/packages/process/demo.debug.yaml +++ b/config/packages/process/demo.debug.yaml @@ -1,6 +1,8 @@ clever_age_process: configurations: demo.debug: + description: > + Ex: bin/console cleverage:process:execute demo.debug options: ui: source: Bar diff --git a/config/packages/process/demo.die.yaml b/config/packages/process/demo.die.yaml index 6866436..e483666 100644 --- a/config/packages/process/demo.die.yaml +++ b/config/packages/process/demo.die.yaml @@ -1,6 +1,8 @@ clever_age_process: configurations: demo.die: + description: > + Ex: bin/console cleverage:process:execute demo.die options: ui: source: Bar diff --git a/config/packages/process/demo.doctrine.read.yaml b/config/packages/process/demo.doctrine.read.yaml index 9c248a6..2742e44 100644 --- a/config/packages/process/demo.doctrine.read.yaml +++ b/config/packages/process/demo.doctrine.read.yaml @@ -1,6 +1,8 @@ clever_age_process: configurations: demo.doctrine.read: + description: > + Ex: bin/console cleverage:process:execute demo.doctrine.read options: ui: source: Bar diff --git a/config/packages/process/demo.logger.yaml b/config/packages/process/demo.logger.yaml index 73e8200..0067102 100644 --- a/config/packages/process/demo.logger.yaml +++ b/config/packages/process/demo.logger.yaml @@ -1,6 +1,8 @@ clever_age_process: configurations: demo.logger: + description: > + Ex: bin/console cleverage:process:execute demo.logger options: ui: source: Bar diff --git a/config/packages/process/demo.sample.yaml b/config/packages/process/demo.sample.yaml index cab171e..db44b11 100644 --- a/config/packages/process/demo.sample.yaml +++ b/config/packages/process/demo.sample.yaml @@ -1,6 +1,8 @@ clever_age_process: configurations: demo.sample: + description: > + Ex: bin/console cleverage:process:execute demo.sample options: ui: source: Bar diff --git a/config/packages/process/demo.upload_and_run.yaml b/config/packages/process/demo.upload_and_run.yaml index ead4f70..bb360c5 100644 --- a/config/packages/process/demo.upload_and_run.yaml +++ b/config/packages/process/demo.upload_and_run.yaml @@ -1,6 +1,8 @@ clever_age_process: configurations: demo.upload_and_run: + description: > + Ex: bin/console cleverage:process:execute demo.upload_and_run --input=/path/to/file.csv -c delimiter:; entry_point: entrypoint # for upload_and_run process entry_point is required options: ui: From 687efc0ec52ba53a0c88359dafd6b1a56ece90fa Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tonon=20Gr=C3=A9gory?= Date: Wed, 4 Dec 2024 10:03:59 +0100 Subject: [PATCH 2/4] #12 Add help instead of description to each process --- config/packages/process/demo.debug.yaml | 2 +- config/packages/process/demo.die.yaml | 2 +- config/packages/process/demo.doctrine.read.yaml | 2 +- config/packages/process/demo.logger.yaml | 2 +- config/packages/process/demo.sample.yaml | 2 +- config/packages/process/demo.upload_and_run.yaml | 2 +- 6 files changed, 6 insertions(+), 6 deletions(-) diff --git a/config/packages/process/demo.debug.yaml b/config/packages/process/demo.debug.yaml index a095df3..20e0576 100644 --- a/config/packages/process/demo.debug.yaml +++ b/config/packages/process/demo.debug.yaml @@ -1,7 +1,7 @@ clever_age_process: configurations: demo.debug: - description: > + help: > Ex: bin/console cleverage:process:execute demo.debug options: ui: diff --git a/config/packages/process/demo.die.yaml b/config/packages/process/demo.die.yaml index e483666..6194c96 100644 --- a/config/packages/process/demo.die.yaml +++ b/config/packages/process/demo.die.yaml @@ -1,7 +1,7 @@ clever_age_process: configurations: demo.die: - description: > + help: > Ex: bin/console cleverage:process:execute demo.die options: ui: diff --git a/config/packages/process/demo.doctrine.read.yaml b/config/packages/process/demo.doctrine.read.yaml index 2742e44..d3d97f7 100644 --- a/config/packages/process/demo.doctrine.read.yaml +++ b/config/packages/process/demo.doctrine.read.yaml @@ -1,7 +1,7 @@ clever_age_process: configurations: demo.doctrine.read: - description: > + help: > Ex: bin/console cleverage:process:execute demo.doctrine.read options: ui: diff --git a/config/packages/process/demo.logger.yaml b/config/packages/process/demo.logger.yaml index 0067102..00bcb62 100644 --- a/config/packages/process/demo.logger.yaml +++ b/config/packages/process/demo.logger.yaml @@ -1,7 +1,7 @@ clever_age_process: configurations: demo.logger: - description: > + help: > Ex: bin/console cleverage:process:execute demo.logger options: ui: diff --git a/config/packages/process/demo.sample.yaml b/config/packages/process/demo.sample.yaml index db44b11..ed89d78 100644 --- a/config/packages/process/demo.sample.yaml +++ b/config/packages/process/demo.sample.yaml @@ -1,7 +1,7 @@ clever_age_process: configurations: demo.sample: - description: > + help: > Ex: bin/console cleverage:process:execute demo.sample options: ui: diff --git a/config/packages/process/demo.upload_and_run.yaml b/config/packages/process/demo.upload_and_run.yaml index bb360c5..8b39f24 100644 --- a/config/packages/process/demo.upload_and_run.yaml +++ b/config/packages/process/demo.upload_and_run.yaml @@ -1,7 +1,7 @@ clever_age_process: configurations: demo.upload_and_run: - description: > + help: > Ex: bin/console cleverage:process:execute demo.upload_and_run --input=/path/to/file.csv -c delimiter:; entry_point: entrypoint # for upload_and_run process entry_point is required options: From c715eea41d9f48e7e29b58209bba9579427d2716 Mon Sep 17 00:00:00 2001 From: xmarchegay Date: Tue, 3 Dec 2024 18:39:04 +0100 Subject: [PATCH 3/4] #12 add demo files --- .../demo.constant_iterable_output.yaml | 20 ++++++++++++ .../process/demo.constant_output.yaml | 20 ++++++++++++ config/packages/process/demo.counter.yaml | 31 +++++++++++++++++++ config/packages/process/demo.dummy.yaml | 31 +++++++++++++++++++ .../process/demo.error_forwarder.yaml | 20 ++++++++++++ .../process/demo.event_dispatcher.yaml | 17 ++++++++++ config/packages/process/demo.stopwatch.yaml | 12 +++++++ 7 files changed, 151 insertions(+) create mode 100644 config/packages/process/demo.constant_iterable_output.yaml create mode 100644 config/packages/process/demo.constant_output.yaml create mode 100644 config/packages/process/demo.counter.yaml create mode 100644 config/packages/process/demo.dummy.yaml create mode 100644 config/packages/process/demo.error_forwarder.yaml create mode 100644 config/packages/process/demo.event_dispatcher.yaml create mode 100644 config/packages/process/demo.stopwatch.yaml diff --git a/config/packages/process/demo.constant_iterable_output.yaml b/config/packages/process/demo.constant_iterable_output.yaml new file mode 100644 index 0000000..e68da74 --- /dev/null +++ b/config/packages/process/demo.constant_iterable_output.yaml @@ -0,0 +1,20 @@ +clever_age_process: + configurations: + demo.constant_iterable_output: + description: > + Ex: bin/console cleverage:process:execute demo.constant_iterable_output + options: + ui: + source: Bar + target: Foo + tasks: + entry: + service: '@CleverAge\ProcessBundle\Task\ConstantIterableOutputTask' + options: + output: + id: 123 + firstname: Test1 + lastname: Test2 + outputs: [ debug ] + debug: + service: '@CleverAge\ProcessBundle\Task\Debug\DebugTask' \ No newline at end of file diff --git a/config/packages/process/demo.constant_output.yaml b/config/packages/process/demo.constant_output.yaml new file mode 100644 index 0000000..1f47cd2 --- /dev/null +++ b/config/packages/process/demo.constant_output.yaml @@ -0,0 +1,20 @@ +clever_age_process: + configurations: + demo.constant_output: + description: > + Ex: bin/console cleverage:process:execute demo.constant_output + options: + ui: + source: Bar + target: Foo + tasks: + entry: + service: '@CleverAge\ProcessBundle\Task\ConstantOutputTask' + options: + output: + id: 123 + firstname: Test1 + lastname: Test2 + outputs: [ debug ] + debug: + service: '@CleverAge\ProcessBundle\Task\Debug\DebugTask' \ No newline at end of file diff --git a/config/packages/process/demo.counter.yaml b/config/packages/process/demo.counter.yaml new file mode 100644 index 0000000..b3719ba --- /dev/null +++ b/config/packages/process/demo.counter.yaml @@ -0,0 +1,31 @@ +clever_age_process: + configurations: + demo.counter: + description: > + Ex: bin/console cleverage:process:execute demo.counter + options: + ui: + source: Bar + target: Foo + tasks: + entry: + service: '@CleverAge\ProcessBundle\Task\ConstantIterableOutputTask' + options: + output: + test1: test1 + test2: test2 + test3: test3 + test4: test4 + test5: test5 + test6: test6 + test7: test7 + test8: test8 + test9: test9 + outputs: [ counter ] + counter: + service: '@CleverAge\ProcessBundle\Task\CounterTask' + options: + flush_every: 3 + outputs: [ debug ] + debug: + service: '@CleverAge\ProcessBundle\Task\Debug\DebugTask' diff --git a/config/packages/process/demo.dummy.yaml b/config/packages/process/demo.dummy.yaml new file mode 100644 index 0000000..7784c63 --- /dev/null +++ b/config/packages/process/demo.dummy.yaml @@ -0,0 +1,31 @@ +clever_age_process: + configurations: + demo.dummy: + description: > + Ex: bin/console cleverage:process:execute demo.dummy + options: + ui: + source: Bar + target: Foo + tasks: + entry: + service: '@CleverAge\ProcessBundle\Task\DummyTask' + outputs: [ output1, output2 ] + output1: + service: '@CleverAge\ProcessBundle\Task\ConstantOutputTask' + options: + output: + id: 123 + firstname: Test1 + lastname: Test2 + outputs: [ debug ] + output2: + service: '@CleverAge\ProcessBundle\Task\ConstantOutputTask' + options: + output: + id: 456 + firstname: Test3 + lastname: Test4 + outputs: [ debug ] + debug: + service: '@CleverAge\ProcessBundle\Task\Debug\DebugTask' diff --git a/config/packages/process/demo.error_forwarder.yaml b/config/packages/process/demo.error_forwarder.yaml new file mode 100644 index 0000000..15f8abd --- /dev/null +++ b/config/packages/process/demo.error_forwarder.yaml @@ -0,0 +1,20 @@ +clever_age_process: + configurations: + demo.error_forwarder: + description: > + Ex: bin/console cleverage:process:execute demo.error_forwarder + options: + ui: + source: Bar + target: Foo + tasks: + entry: + service: '@CleverAge\ProcessBundle\Task\ConstantIterableOutputTask' + options: + output: + error1: Error 1 + error2: Error 2 + error3: Error 3 + outputs: [ error_forwarder ] + error_forwarder: + service: '@CleverAge\ProcessBundle\Task\Debug\ErrorForwarderTask' \ No newline at end of file diff --git a/config/packages/process/demo.event_dispatcher.yaml b/config/packages/process/demo.event_dispatcher.yaml new file mode 100644 index 0000000..7cf7250 --- /dev/null +++ b/config/packages/process/demo.event_dispatcher.yaml @@ -0,0 +1,17 @@ +clever_age_process: + configurations: + demo.event_dispatcher: + description: > + Ex: bin/console cleverage:process:execute demo.event_dispatcher + options: + ui: + source: Bar + target: Foo + tasks: + entry: + service: '@CleverAge\ProcessBundle\Task\Event\EventDispatcherTask' + options: + event_name: 'myapp.myevent' + outputs: [ debug ] + debug: + service: '@CleverAge\ProcessBundle\Task\Debug\DebugTask' \ No newline at end of file diff --git a/config/packages/process/demo.stopwatch.yaml b/config/packages/process/demo.stopwatch.yaml new file mode 100644 index 0000000..b36213a --- /dev/null +++ b/config/packages/process/demo.stopwatch.yaml @@ -0,0 +1,12 @@ +clever_age_process: + configurations: + demo.stopwatch: + description: > + Ex: bin/console cleverage:process:execute demo.stopwatch + options: + ui: + source: Bar + target: Foo + tasks: + entry: + service: '@CleverAge\ProcessBundle\Task\Debug\StopwatchTask' \ No newline at end of file From 3fc0034c93c408a1e29f3994959a1205816c12dc Mon Sep 17 00:00:00 2001 From: Nicolas Joubert Date: Fri, 6 Dec 2024 18:16:38 +0100 Subject: [PATCH 4/4] #12 Move example information on demo processes from description to help. Add descriptions. Rename demo.sample to demo.transformer --- .../packages/process/demo.constant_iterable_output.yaml | 4 +++- config/packages/process/demo.constant_output.yaml | 4 +++- config/packages/process/demo.counter.yaml | 2 ++ config/packages/process/demo.debug.yaml | 2 ++ config/packages/process/demo.die.yaml | 2 ++ config/packages/process/demo.doctrine.read.yaml | 2 ++ config/packages/process/demo.dummy.yaml | 2 ++ config/packages/process/demo.error_forwarder.yaml | 4 +++- config/packages/process/demo.event_dispatcher.yaml | 4 +++- config/packages/process/demo.logger.yaml | 2 ++ config/packages/process/demo.rest.yaml | 2 ++ config/packages/process/demo.soap.yaml | 2 +- config/packages/process/demo.stopwatch.yaml | 4 +++- .../process/{demo.sample.yaml => demo.transformer.yaml} | 4 +++- config/packages/process/demo.upload_and_run.yaml | 8 +++++--- 15 files changed, 38 insertions(+), 10 deletions(-) rename config/packages/process/{demo.sample.yaml => demo.transformer.yaml} (93%) diff --git a/config/packages/process/demo.constant_iterable_output.yaml b/config/packages/process/demo.constant_iterable_output.yaml index e68da74..66f1b6c 100644 --- a/config/packages/process/demo.constant_iterable_output.yaml +++ b/config/packages/process/demo.constant_iterable_output.yaml @@ -2,6 +2,8 @@ clever_age_process: configurations: demo.constant_iterable_output: description: > + A simple process which iterate a constant output data + help: > Ex: bin/console cleverage:process:execute demo.constant_iterable_output options: ui: @@ -17,4 +19,4 @@ clever_age_process: lastname: Test2 outputs: [ debug ] debug: - service: '@CleverAge\ProcessBundle\Task\Debug\DebugTask' \ No newline at end of file + service: '@CleverAge\ProcessBundle\Task\Debug\DebugTask' diff --git a/config/packages/process/demo.constant_output.yaml b/config/packages/process/demo.constant_output.yaml index 1f47cd2..ede058e 100644 --- a/config/packages/process/demo.constant_output.yaml +++ b/config/packages/process/demo.constant_output.yaml @@ -2,6 +2,8 @@ clever_age_process: configurations: demo.constant_output: description: > + A simple process which output a constant data + help: > Ex: bin/console cleverage:process:execute demo.constant_output options: ui: @@ -17,4 +19,4 @@ clever_age_process: lastname: Test2 outputs: [ debug ] debug: - service: '@CleverAge\ProcessBundle\Task\Debug\DebugTask' \ No newline at end of file + service: '@CleverAge\ProcessBundle\Task\Debug\DebugTask' diff --git a/config/packages/process/demo.counter.yaml b/config/packages/process/demo.counter.yaml index b3719ba..d5d142c 100644 --- a/config/packages/process/demo.counter.yaml +++ b/config/packages/process/demo.counter.yaml @@ -2,6 +2,8 @@ clever_age_process: configurations: demo.counter: description: > + A simple process which count the number of times the task is processed and continue every 3 iterations + help: > Ex: bin/console cleverage:process:execute demo.counter options: ui: diff --git a/config/packages/process/demo.debug.yaml b/config/packages/process/demo.debug.yaml index 20e0576..13cf8e0 100644 --- a/config/packages/process/demo.debug.yaml +++ b/config/packages/process/demo.debug.yaml @@ -1,6 +1,8 @@ clever_age_process: configurations: demo.debug: + description: > + A simple process which output as debug help: > Ex: bin/console cleverage:process:execute demo.debug options: diff --git a/config/packages/process/demo.die.yaml b/config/packages/process/demo.die.yaml index 6194c96..29fc198 100644 --- a/config/packages/process/demo.die.yaml +++ b/config/packages/process/demo.die.yaml @@ -1,6 +1,8 @@ clever_age_process: configurations: demo.die: + description: > + A simple process which output as die help: > Ex: bin/console cleverage:process:execute demo.die options: diff --git a/config/packages/process/demo.doctrine.read.yaml b/config/packages/process/demo.doctrine.read.yaml index d3d97f7..f5c4f09 100644 --- a/config/packages/process/demo.doctrine.read.yaml +++ b/config/packages/process/demo.doctrine.read.yaml @@ -1,6 +1,8 @@ clever_age_process: configurations: demo.doctrine.read: + description: > + A simple process to use DoctrineProcessBundle as database reader help: > Ex: bin/console cleverage:process:execute demo.doctrine.read options: diff --git a/config/packages/process/demo.dummy.yaml b/config/packages/process/demo.dummy.yaml index 7784c63..eb97bae 100644 --- a/config/packages/process/demo.dummy.yaml +++ b/config/packages/process/demo.dummy.yaml @@ -2,6 +2,8 @@ clever_age_process: configurations: demo.dummy: description: > + A simple process with multiple output + help: > Ex: bin/console cleverage:process:execute demo.dummy options: ui: diff --git a/config/packages/process/demo.error_forwarder.yaml b/config/packages/process/demo.error_forwarder.yaml index 15f8abd..1b041ee 100644 --- a/config/packages/process/demo.error_forwarder.yaml +++ b/config/packages/process/demo.error_forwarder.yaml @@ -2,6 +2,8 @@ clever_age_process: configurations: demo.error_forwarder: description: > + A simple process which forward data to an error output + help: > Ex: bin/console cleverage:process:execute demo.error_forwarder options: ui: @@ -17,4 +19,4 @@ clever_age_process: error3: Error 3 outputs: [ error_forwarder ] error_forwarder: - service: '@CleverAge\ProcessBundle\Task\Debug\ErrorForwarderTask' \ No newline at end of file + service: '@CleverAge\ProcessBundle\Task\Debug\ErrorForwarderTask' diff --git a/config/packages/process/demo.event_dispatcher.yaml b/config/packages/process/demo.event_dispatcher.yaml index 7cf7250..f7f843a 100644 --- a/config/packages/process/demo.event_dispatcher.yaml +++ b/config/packages/process/demo.event_dispatcher.yaml @@ -2,6 +2,8 @@ clever_age_process: configurations: demo.event_dispatcher: description: > + A simple process which dispatch an event + help: > Ex: bin/console cleverage:process:execute demo.event_dispatcher options: ui: @@ -14,4 +16,4 @@ clever_age_process: event_name: 'myapp.myevent' outputs: [ debug ] debug: - service: '@CleverAge\ProcessBundle\Task\Debug\DebugTask' \ No newline at end of file + service: '@CleverAge\ProcessBundle\Task\Debug\DebugTask' diff --git a/config/packages/process/demo.logger.yaml b/config/packages/process/demo.logger.yaml index 00bcb62..c32bef3 100644 --- a/config/packages/process/demo.logger.yaml +++ b/config/packages/process/demo.logger.yaml @@ -1,6 +1,8 @@ clever_age_process: configurations: demo.logger: + description: > + A simple process which log a message into a specific logger help: > Ex: bin/console cleverage:process:execute demo.logger options: diff --git a/config/packages/process/demo.rest.yaml b/config/packages/process/demo.rest.yaml index b54000d..4fad36d 100644 --- a/config/packages/process/demo.rest.yaml +++ b/config/packages/process/demo.rest.yaml @@ -1,6 +1,8 @@ clever_age_process: configurations: demo.rest: + description: > + A simple process to use RestProcessBundle help: > Ex: bin/console cleverage:process:execute demo.rest -c codePostal:"'46800'" options: diff --git a/config/packages/process/demo.soap.yaml b/config/packages/process/demo.soap.yaml index ced96ee..d546265 100644 --- a/config/packages/process/demo.soap.yaml +++ b/config/packages/process/demo.soap.yaml @@ -4,7 +4,7 @@ clever_age_process: description: > A simple process to use SoapProcessBundle help: > - bin/console cleverage:process:execute demo.soap + Ex: bin/console cleverage:process:execute demo.soap options: ui: source: Bar diff --git a/config/packages/process/demo.stopwatch.yaml b/config/packages/process/demo.stopwatch.yaml index b36213a..825a10f 100644 --- a/config/packages/process/demo.stopwatch.yaml +++ b/config/packages/process/demo.stopwatch.yaml @@ -2,6 +2,8 @@ clever_age_process: configurations: demo.stopwatch: description: > + A simple process which output as stopwatch + help: > Ex: bin/console cleverage:process:execute demo.stopwatch options: ui: @@ -9,4 +11,4 @@ clever_age_process: target: Foo tasks: entry: - service: '@CleverAge\ProcessBundle\Task\Debug\StopwatchTask' \ No newline at end of file + service: '@CleverAge\ProcessBundle\Task\Debug\StopwatchTask' diff --git a/config/packages/process/demo.sample.yaml b/config/packages/process/demo.transformer.yaml similarity index 93% rename from config/packages/process/demo.sample.yaml rename to config/packages/process/demo.transformer.yaml index ed89d78..0a295c7 100644 --- a/config/packages/process/demo.sample.yaml +++ b/config/packages/process/demo.transformer.yaml @@ -1,8 +1,10 @@ clever_age_process: configurations: demo.sample: + description: > + A simple process which transform data help: > - Ex: bin/console cleverage:process:execute demo.sample + Ex: bin/console cleverage:process:execute demo.transformer options: ui: source: Bar diff --git a/config/packages/process/demo.upload_and_run.yaml b/config/packages/process/demo.upload_and_run.yaml index 8b39f24..9262c46 100644 --- a/config/packages/process/demo.upload_and_run.yaml +++ b/config/packages/process/demo.upload_and_run.yaml @@ -1,8 +1,10 @@ clever_age_process: configurations: demo.upload_and_run: + description: > + A simple process which upload a csv file and read it to log/debug each line help: > - Ex: bin/console cleverage:process:execute demo.upload_and_run --input=/path/to/file.csv -c delimiter:; + Ex: bin/console cleverage:process:execute demo.upload_and_run --input=/path/to/file.csv -c delimiter:";" entry_point: entrypoint # for upload_and_run process entry_point is required options: ui: @@ -27,7 +29,7 @@ clever_age_process: choices: [',', ';'] message: delimiter context must be , or ;. {{ value }} given. tasks: - entrypoint: # Add log info to describe witch file is reading + entrypoint: # Add log info to describe which file is reading service: '@CleverAge\ProcessBundle\Task\Reporting\LoggerTask' options: message: Read file @@ -38,7 +40,7 @@ clever_age_process: service: '@CleverAge\ProcessBundle\Task\File\Csv\InputCsvReaderTask' outputs: [ log_line, dump ] options: - delimiter: '{{ delimiter }}' ## delimiter is contextualized you must add -c delimiter:; on console execute + delimiter: '{{ delimiter }}' ## delimiter is contextualized you must add -c delimiter:";" on console execute log_line: service: '@CleverAge\ProcessBundle\Task\Reporting\LoggerTask' options: