BAP-21665: Cover documentation examples with tests (#33817)

- Updated the namespaces in the documentation and fixed various bugs
- Improved Entity, Entity Management, Security, Data Grid Workflows, and some other documentation sections and covered them with tests
- Added a new application along with its associated entity and behat configuration.

---------

Co-authored-by: timofiyprisyazhnyuk <[email protected]>
Co-authored-by: Kateryna Isakova <[email protected]>

Author: 3 people

backend/architecture/tech-stack/search-index.rst

@@ -202,7 +202,7 @@ Here is example of the document from the website index type under oro_product_WE
    "visibility_anonymous":1,
    "visibility_new":1,
    "is_visible_by_default":1,
-   "all_text_1":"Retail Supplies Credit Card Pin Pad Reader Choosing the right credit card processing terminal to fit your business needs can help you increase your profits and reduce your processing costs. This credit card reader helps you do just that. Its easy-to-use ATM style interface accepts PIN-based debit card transactions and swipes traditional payment cards. It also accepts chip cards and features a built-in receipt printer Product Information & Features: Catalog Page: 2976 Performs PIN based debit card transactions Accepts chip cards Prints transaction receipts Connectivity: USB (not included) Large, backlit display Supports all magnetic stripe cards Color: Purple Technical Specs: Width: 6\u201d Height: 3\u201d Weight: .6 lb. ACME defaultMetaDescription defaultMetaKeywords 1AB92",
+   "all_text_1":"Retail Supplies Credit Card Pin Pad Reader Choosing the right credit card processing terminal to fit your business needs can help you increase your profits and reduce your processing costs. This credit card reader helps you do just that. Its easy-to-use ATM style interface accepts PIN-based debit card transactions and swipes traditional payment cards. It also accepts chip cards and features a built-in receipt printer Product Information & Features: Catalog Page: 2976 Performs PIN based debit card transactions Accepts chip cards Prints transaction receipts Connectivity: USB (not included) Large, backlit display Supports all magnetic stripe cards Color: Purple Technical Specs: Width: 6\u201d Height: 3\u201d Weight: .6 lb. Acme defaultMetaDescription defaultMetaKeywords 1AB92",
    "sku":"1AB92",
    "names_1":"Credit Card Pin Pad Reader",
    "shortDescriptions_1":"Choosing the right credit card processing terminal to fit your business needs can help you increase your profits and reduce your processing costs. This credit card reader helps you do just that. Its' easy-to-use ATM style interface accepts PIN-based debit card transactions and swipes traditional payment cards. It also accepts chip cards and features a built-in receipt printer",

backend/automated-tests/behat.rst

@@ -198,42 +198,42 @@ To run ChromeDriver in the background, append the ampersand symbol (&) to the en
 Run Tests
 ~~~~~~~~~
 
-Before you begin, familiarize yourself with behat arguments and options. Run ``bin/behat --help`` for a detailed description.
+Before you begin, familiarize yourself with behat arguments and options. Run ``php bin/behat --help`` for a detailed description.
 
 When the Oro application is installed without demo data and is running, and the ChromeDriver is running, you can start running the behat tests by feature from the root of the application. You can use one of the following commands.
 
 Run the feature test scenario:
 
 .. code-block:: none
 
-    bin/behat vendor/oro/platform/src/Oro/Bundle/UserBundle/Tests/Behat/Features/login.feature -vvv
+    php bin/behat vendor/oro/platform/src/Oro/Bundle/UserBundle/Tests/Behat/Features/login.feature -vvv
 
 Preview all available feature steps:
 
 .. code-block:: none
 
-    bin/behat -dl -s OroUserBundle
+    php bin/behat -dl -s OroUserBundle
 
 View steps with full description and examples:
 
 .. code-block:: none
 
-    bin/behat -di -s OroUserBundle
+    php bin/behat -di -s OroUserBundle
 
 Every bundle has its dedicated test suite that can be run separately:
 
 .. code-block:: none
 
-    bin/behat -s OroUserBundle
+    php bin/behat -s OroUserBundle
 
 Running Сonsumers
 ~~~~~~~~~~~~~~~~~
 
-To run multiple consumers during behat tests, you can use the ``--consumers`` option in ``bin/behat``, which applies an integer argument, for example:
+To run multiple consumers during behat tests, you can use the ``--consumers`` option in ``php bin/behat``, which applies an integer argument, for example:
 
 .. code-block:: none
 
-    bin/behat --consumers=4
+    php bin/behat --consumers=4
 
 By default, when the option is not specified, 2 consumers are run.
 
@@ -358,7 +358,7 @@ You can disable feature isolation by adding the ``--skip-isolators`` option to t
 Disable Message Consumer Background Running
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-To simulate production conditions more accurately during testing, you can disable the message consumer background running using the ``--do-not-run-consumer`` option in ``bin/behat``.
+To simulate production conditions more accurately during testing, you can disable the message consumer background running using the ``--do-not-run-consumer`` option in ``php bin/behat``.
 
 Be aware that if you choose to use this option, the consumer will not be launched, and the application will not process any messages from the message queue. This could cause problems if you are testing functionality that relies on the timely processing of messages by the consumer.
 
@@ -636,7 +636,7 @@ You can use references to the entities in both inline and |alice fixtures|.
 * It is prohibited to modify or add new entities within Initializer.
 * It should implement ``ReferenceRepositoryInitializerInterface``.
 * It should be registered as the Behat container service in the ``{BundlePath}/Tests/Behat/services.yml`` file with the ``oro_behat.reference_repository_initializer`` tag.
-* To show all references, use the ``bin/behat --available-references`` command.
+* To show all references, use the ``php bin/behat --available-references`` command.
 
 The most commonly used references:
 
@@ -654,7 +654,7 @@ You can try:
 
 .. code-block:: none
 
-    bin/behat --dry-run
+    php bin/behat --dry-run
 
 This can be useful in case you are unsure that you have declared all the necessary context for your feature.
 OroBehatExtension enhances this feature and adds extra functionality.
@@ -884,7 +884,7 @@ A quick way to do so is to dry-run your feature tests. In the console, run the f
 
 .. code-block:: none
 
-    bin/behat path/to/your.feature --dry-run --append-snippets --snippets-type=regex
+    php bin/behat path/to/your.feature --dry-run --append-snippets --snippets-type=regex
 
 The feature is executed in the *--dry-run* mode, and at the final stage of execution, you are prompted to add undefined steps mock implementation to one of the existing contexts.
 
@@ -928,12 +928,12 @@ Type the following command in your console:
 
 .. code-block:: none
 
-    bin/behat -dl -s AcmeDemoBundle | grep "flash message"
+    php bin/behat -dl -s AcmeDemoBundle | grep "flash message"
 
 
 .. code-block:: bash
 
-    $ bin/behat -dl -s OroUserBundle | grep "flash message"
+    $ php bin/behat -dl -s OroUserBundle | grep "flash message"
     OroUserBundle | Then /^(?:|I )follow "(?P<title>[^"]+)" link within flash message "(?P<message>([^"\\]|\\.)*)"$/
     OroUserBundle | Then /^(?:|I )should see "(?P<title>[^"]+)" flash message$/
     OroUserBundle | Then /^(?:|I )should see '(?P<title>[^']+)' flash message$/
@@ -950,12 +950,12 @@ Type the following command in your console:
 
 .. code-block:: none
 
-    bin/behat -dl -s AcmeDemoBundle | grep "grid"
+    php bin/behat -dl -s AcmeDemoBundle | grep "grid"
 
 
 .. code-block:: none
 
-    $ bin/behat -dl -s OroUserBundle | grep "grid"
+    $ php bin/behat -dl -s OroUserBundle | grep "grid"
     OroUserBundle | Then /^I see that grid has scrollable header$/
     OroUserBundle | Then /^I see that grid header is sticky$/
     OroUserBundle | When /^I don't select any record from "(?P<gridName>[^"]+)"$/

backend/automated-tests/debug-behat-tests.rst

@@ -19,14 +19,14 @@ How to Debug Behat Tests
 Enable Very Verbose Output
 ^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-You can increase the output verbosity to see more details on what's going on by adding the ``-v``, ``-vv``, or ``-vvv`` option to ``bin/behat``.
+You can increase the output verbosity to see more details on what's going on by adding the ``-v``, ``-vv``, or ``-vvv`` option to ``php bin/behat``.
 This enables verbose, very verbose, or very very verbose output accordingly.
 
 - ``-v, --verbose[=VERBOSE]`` -- Increase verbosity of exceptions.
 
 .. code-block:: bash
 
-    bin/behat path/to/your.feature -vv
+    php bin/behat path/to/your.feature -vv
 
 Review Error Messages
 ^^^^^^^^^^^^^^^^^^^^^

backend/entities-data-management/actions/action-groups.rst

@@ -12,35 +12,12 @@ Parameters are accessible in actions as the root node of contextual data (e.g.,
 Action Group Configuration
 --------------------------
 
-File `<bundleResourceRoot>/config/oro/actions.yml`
-
-.. code-block:: none
-
-    action_groups:                                      # root node for action groups
-        demo_flash_greetings_to:                        # name of action group
-            replace:                                    # (optional) the list of nodes that should be replaced during the overriding
-                - actions                               # node name
-            parameters:                                 # parameters declaration node
-                what:                                   # name of the parameter
-                    type: AcmeDemoBundle/String/Phrase  # (optional, default = any) type validation of parameter (available types: integer, string, boolean, array, double, object, PHP class)
-                    message: "Bad type"                 # (optional) message to be prompted if parameter validation failure met
-                    default: "Hello"                    # (optional) default value for optional parameter, if not set then parameter `what` is required
-                who: ~                                  # set all defaults to parameter options (type: any)
-            conditions:                                 # Condition expression
-                @not_empty: [$.who]
-            actions:                                    # list of actions that should be executed
-                - '@call_service_method':
-                    service: type_guesser
-                    method: guess
-                    method_parameters: [$.who]          # as you can see, parameters are accessible from root $.<parameterName>
-                    attribute: $.typeOfWho
-                - '@flash_message':
-                    message: "%param1%, %param2%!"
-                    type: 'info'
-                    message_parameters:
-                        param1: $.what
-                        param2: $.typeOfWho
+.. oro_integrity_check:: c99c6e9f1a933e282f068ef1fcf559e3a7113ee0
 
+    .. literalinclude:: /code_examples/commerce/demo/Resources/config/oro/actions.yml
+        :caption: src/Acme/Bundle/DemoBundle/Resources/config/oro/actions.yml
+        :language: yaml
+        :lines: 1-24
 
 Next, run this action_group as follows: