Skip to content

Commit

Permalink
Apama Analytics EPL Apps tools for 10.16.0.1
Browse files Browse the repository at this point in the history
  • Loading branch information
skom-c8y committed Feb 27, 2023
1 parent 980f0e2 commit b13267e
Show file tree
Hide file tree
Showing 8 changed files with 14 additions and 10 deletions.
4 changes: 4 additions & 0 deletions changelog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@
Change Log
============

10.15.0.4
----------
+ An issue where the rendered documentation pages were showing a 404 error when accessed has been resolved.

10.14.0.0
----------

Expand Down
4 changes: 2 additions & 2 deletions doc/testing-epl.rst
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ To see how this can be done, have a look at the ``createNewDevice`` action below
return reqId;
}

This action initializes a ``ManagedObject`` (using the "PYSYS\_" naming prefix and adding the ``c8y_IsDevice`` property), before sending it using a ``withResponse`` action. It then confirms that it has been successfully created using listeners for ``ObjectCommitted`` and ``ObjectCommitFailed`` events. Whenever you are creating or updating an object in Cumulocity IoT and you want to verify that the change has been successful, it is recommended that you use the ``withResponse`` action in conjunction with ``ObjectCommitted`` and ``ObjectCommitFailed`` listeners (for more information, see the information on updating a managed object in the 'The Cumulocity IoT Transport Connectivity Plug-in' section of the `documentation <https://documentation.softwareag.com/pam/10.15.0/en/webhelp/pam-webhelp/index.html#page/pam-webhelp%2Fco-ConApaAppToExtCom_the_cumulocity_connectivity_plug_in.html>`_). Using this approach you can easily relay when the process has completed (which is done by sending an event, ``DeviceCreated``, in the example above), and in the event of an error you can cause the test to exit quickly.
This action initializes a ``ManagedObject`` (using the "PYSYS\_" naming prefix and adding the ``c8y_IsDevice`` property), before sending it using a ``withResponse`` action. It then confirms that it has been successfully created using listeners for ``ObjectCommitted`` and ``ObjectCommitFailed`` events. Whenever you are creating or updating an object in Cumulocity IoT and you want to verify that the change has been successful, it is recommended that you use the ``withResponse`` action in conjunction with ``ObjectCommitted`` and ``ObjectCommitFailed`` listeners (for more information, see the information on updating a managed object in the 'The Cumulocity IoT Transport Connectivity Plug-in' section of the `documentation <https://documentation.softwareag.com/pam/10.15.1/en/webhelp/pam-webhelp/index.html#page/pam-webhelp%2Fco-ConApaAppToExtCom_the_cumulocity_connectivity_plug_in.html>`_). Using this approach you can easily relay when the process has completed (which is done by sending an event, ``DeviceCreated``, in the example above), and in the event of an error you can cause the test to exit quickly.


Sending events to your EPL apps
Expand Down Expand Up @@ -135,7 +135,7 @@ To receive the alarm event, firstly we must subscribe to the relevant channel, `
Querying Cumulocity IoT
========================

An alternative approach to the one demonstrated in the '`Receiving events from your EPL apps`_' section involves querying Cumulocity IoT. With this approach you are able to retrieve historical data. It is possible to query Cumulocity IoT for alarms, events, measurements, operations, and managed objects. More information on querying can be found in 'The Cumulocity IoT Transport Connectivity Plug-in' section of the `documentation <https://documentation.softwareag.com/pam/10.15.0/en/webhelp/pam-webhelp/index.html#page/pam-webhelp%2Fco-ConApaAppToExtCom_the_cumulocity_connectivity_plug_in.html>`_.
An alternative approach to the one demonstrated in the '`Receiving events from your EPL apps`_' section involves querying Cumulocity IoT. With this approach you are able to retrieve historical data. It is possible to query Cumulocity IoT for alarms, events, measurements, operations, and managed objects. More information on querying can be found in 'The Cumulocity IoT Transport Connectivity Plug-in' section of the `documentation <https://documentation.softwareag.com/pam/10.15.1/en/webhelp/pam-webhelp/index.html#page/pam-webhelp%2Fco-ConApaAppToExtCom_the_cumulocity_connectivity_plug_in.html>`_.

Using an example of a test that checks for an alarm, this would involve subscribing to the ``FindAlarmResponse.SUBSCRIBE_CHANNEL`` and using a ``FindAlarm`` event with ``FindAlarmResponse`` and ``FindAlarmResponseAck`` listeners::

Expand Down
2 changes: 1 addition & 1 deletion doc/using-pysys.rst
Original file line number Diff line number Diff line change
Expand Up @@ -179,7 +179,7 @@ To run in Apama EPL Apps, your run.py should look something like this:
def validate(self):
# check none of the tests failed
self.assertGrep(self.platform.getApamaLogFile(), expr=' (ERROR|FATAL) .*', contains=False)
self.assertGrep(self.platform.getApamaLogFile(), expr=' (ERROR|FATAL) .* eplfiles\.', contains=False)
To run with a local correlator, it should look something like this:
Expand Down
4 changes: 2 additions & 2 deletions readme.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ This project is licensed under the Apache 2.0 license - see https://www.apache.o

Apama EPL Apps Tools Version
-------------------------
This version of the SDK supports Apama EPL Apps Tools 10.15.0.
This version of the SDK supports Apama EPL Apps Tools 10.16.0.

Documentation
-------------
Expand All @@ -39,7 +39,7 @@ To find out how to performance test your EPL apps look at `Performance testing E

In order to view the documentation on classes for PySys helpers for Apama EPL Apps see: `PySys helpers <https://softwareag.github.io/apama-eplapps-tools/doc/pydoc/autodocgen/apamax.eplapplications.html#module-apamax.eplapplications>`_.

See `Apama Documentation <https://documentation.softwareag.com/pam/10.15.0/en/webhelp>`_, `Streaming Analytics guide <https://cumulocity.com/guides/apama>`_ and `PySys Documentation <https://pysys-test.github.io/pysys-test>`_ for further docs.
See `Apama Documentation <https://documentation.softwareag.com/pam/10.15.1/en/webhelp>`_, `Streaming Analytics guide <https://cumulocity.com/guides/apama>`_ and `PySys Documentation <https://pysys-test.github.io/pysys-test>`_ for further docs.

System requirements
-------------------
Expand Down
2 changes: 1 addition & 1 deletion samples/advanced/EPLAppsTest/run.py
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ def execute(self):

def validate(self):
# check none of the tests failed
self.assertGrep(self.platform.getApamaLogFile(), expr=' (ERROR|FATAL) .*', contains=False)
self.assertGrep(self.platform.getApamaLogFile(), expr=' (ERROR|FATAL) .* eplfiles\.', contains=False)



Expand Down
2 changes: 1 addition & 1 deletion scripts/eplapp.py
Original file line number Diff line number Diff line change
Expand Up @@ -219,7 +219,7 @@ def main(self, args) -> int:
:return: 0 if the command was executed successfully, or a non-zero error code otherwise.
"""
try:
RELEASE_TRAIN_VERSION='10.15.0'
RELEASE_TRAIN_VERSION='10.16.0'
optlist, commands = self.parseCommandLineArgs(args)
except Exception as err:
print(f'error: Could not parse command line options. {err}')
Expand Down
4 changes: 2 additions & 2 deletions testframework/apamax/eplapplications/basetest.py
Original file line number Diff line number Diff line change
Expand Up @@ -581,10 +581,10 @@ def execute(self):

def validate(self):
"""
Ensures that no errors were logged in the platform log file while we were running the test.
Ensures that no tests failed.
"""
self.log.info("Checking for errors")
self.assertGrep(self.platform.getApamaLogFile(), expr=' (ERROR|FATAL) .*', contains=False)
self.assertGrep(self.platform.getApamaLogFile(), expr=' (ERROR|FATAL) .* eplfiles\.', contains=False)

def shutdown(self):
"""
Expand Down
2 changes: 1 addition & 1 deletion testframework/apamax/eplapplications/buildVersions.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,4 @@
# See the License for the specific language governing permissions and limitations under the License.


RELEASE_TRAIN_VERSION='10.15.0'
RELEASE_TRAIN_VERSION='10.16.0'

0 comments on commit b13267e

Please sign in to comment.