Skip to Content

Changes for page Testing in eMagiz

Last modified by Erik Bakker on 2024/08/08 11:24
From version 2.1
edited by Bouke Reitsma
on 2023/07/05 10:36
Change comment: There is no comment for this version
To version 11.1
edited by Bouke Reitsma
on 2023/07/05 10:57
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1,73 +1,62 @@
1 -~{~{container}}~{~{container layoutStyle="columns"}}~(~(~(
2 -This fundamental will zoom in on which traceability concepts we have incorporated within the eMagiz portal to ensure that data passes from A to B. We will focus on traceability from three perspectives. At first, we zoom in on whether a message has been sent from A to B. Secondly, we determine whether a specific message has been dispatched from A to B. Thirdly, we focus on proving that the message was indeed sent years after a message has been sent. After this journey, you should have a solid understanding of which options eMagiz offers to trace messages between various systems across the integration platform.
1 +{{container}}{{container layoutStyle="columns"}}(((
2 +In this fundamental we discuss different testing methods available in software development and discuss how these methods can be used and/or implanted within the platform. Testing in eMagiz can already be done within the Create phase and within deployed integrations via the Deploy and Manage phases. After reading this fundamental you should be able to understand the concepts of different testing methods and how these are incorporated within the eMagiz platform.
3 3  
4 -All these concepts are used for Traceability & Compliancy business requirements...
4 +Should you have any questions, please get in touch with [[academy@emagiz.com>>mailto:academy@emagiz.com]].
5 5  
6 -Should you have any questions, please get in touch with academy@emagiz.com.
6 +== 1. Prerequisites ==
7 7  
8 -~== 1. Prerequisites ==
8 +* Basic Knowledge of the eMagiz Platform
9 9  
10 -~* An overall view of the capabilities of the eMagiz platform will be helpful
10 +== 2. Key concepts ==
11 11  
12 -~== 2. Key concepts ==
12 +* Unit Testing
13 +* Regression testing
14 +* Performance Testing
15 +* End-To-End Testing
13 13  
14 -~* eMagiz offers various options to trace messages across the platform
15 -~* The three most noteworthy options are
16 - ~* Queue Statistics
17 - ~* Data Sink
18 - ~* Long Term Archiving
17 +== 3. Testing in eMagiz ==
19 19  
20 -~== 3. Traceability in eMagiz ==
19 +This fundamental will zoom in on the testing functionality incorperated within the eMagiz portal. We will focus on different aspects of testing which can be executed at different moments within the development in your integrations. We cover four different types of testing which are part of software testing in general and explain them on a conceptual level. For each test we also discuss how those are integrated within the portal and where to find further explanation on applying those test within eMagiz.
21 21  
22 -This fundamental will zoom in on which traceability concepts we have incorporated within the eMagiz portal to ensure that data travels from A to B. We will focus on traceability from three perspectives. At first, we zoom in on whether a message has been sent from A to B. Secondly, we determine whether a specific message has been dispatched from A to B. Thirdly, we focus on proving that the message was indeed sent years after a message has been sent. After this journey, you should have a solid understanding of which options eMagiz offers to trace messages between various systems across the integration platform.
21 +=== 3.1 Unit Testing ===
23 23  
24 -~=== 3.1 Queue Statistics ===
23 +Unit testing is a common practice within software platforms. Usually, unit tests are performed by developers during development. It entails testing individual integrations or the components within an integration, such as transformations or mappings. The unit test aims to test early within the development process to identify and fix issues early before they become more difficult and costly to find and solve.
25 25  
26 -In the Manage phase of eMagiz, we collect statistics to determine whether a message has been sent from one system to another. For example, we have the queue statistics for messaging and API Gateway. In this overview, you can zoom in on a specific queue and see the number of messages sent within that timeframe, the number of messages in the queue at a particular time, and whether or not messages are consumed at a specific moment in time. See below for an illustration of this concept.
25 +Within eMagiz, we have a dedicated unit testing functionality called "flow testing." One of the key benefits of flow testing is that your integration does not have to be deployed. Therefore, findings can be easily implemented during development. eMagiz supports certain components' live testing to test communication with external systems. More information on flow tests can be found in the following microlearnings:
27 27  
28 -~[~[image~:Main.Images.Fundamental.WebHome@fundamental-traceability-in-emagiz~-~-queue-statistics.png]]
27 +* [[Crash Course Platfrom>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.WebHome||target="blank"]]
28 +* [[Testing API Gateway>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.Testing API Gateway.intermediate-testing-emagiz-api-gateway-testing-api-gateway||target="blank"]]
29 29  
30 -With the help of this overview, you can determine that a queue has processed a message at a specific moment. However, the statistics do not tell you anything about the content of the data. For most use cases, this is sufficient as the fact that a message has been sent is proof that the receiving application has received the data and can be found in that application.
30 +=== 3.2 Regression Testing ===
31 31  
32 -For more information on queue statistics please check out the following ~[~[Crashcourse Messaging>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Messaging.crashcourse-messaging-interpreting-queue-statistics||target="blank"]]
32 +Another testing method used within software development is regression testing. Regression tests ensure that existing functionality is not impacted by newly developed functionality. Running these tests is crucial to preventing unexpected negative changes for customers. Regression tests can be applied on different levels, from individual functionality to the whole platform.
33 33  
34 -In some cases, however, more traceability is needed for Ops work. For those use cases, we have additional functionality within eMagiz called data sink.
34 +The main functionality within the eMagiz platform to perform regression testing on your integrations is called "Automated flow testing." For every flow test, there is the option to automate them. When a flow test is automated, it will run all automated flow tests once a new version is committed. If the test fails, you will be notified on the flow-level and get a result overview on release activation. More information can be found in the microlearning:
35 35  
36 -~=== 3.2 Data Sink ===
36 +* [[Testing API Gateway>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.Testing in eMagiz.intermediate-testing-in-emagiz-regression-testing||target="blank"]]
37 37  
38 -On top of the standard Manage functionality in eMagiz, you can acquire additional functionality that allows you to sink data at any given point in the flow into a bucket hosted by eMagiz. We advise you to do this twice per integration. Once when the message enters the eMagiz platform and once the message leaves the eMagiz platform. By providing a unique identifier (i.e., an order number), you can search through this data for maximum 180 days (minimum 30 days) to determine whether a specific message with a particular identifier is indeed received and/or delivered by eMagiz in the Manage phase of eMagiz. See below for an illustration of this functionality.
38 +==== 3.3 Performance Testing ====
39 39  
40 -~[~[image~:Main.Images.Fundamental.WebHome@fundamental-traceability-in-emagiz~-~-data-sink-view-manage.png]]
40 +A third method for testing is the performance test. Within a performance test, not the content is important but the amount of load you test on your test subject. In the case of integrations, it means, in general, the number of messages sent over a certain integration. Normally your production environment handles more load than a test or acceptance environment. With a performance test, you can estimate how much impact a new integration has on resources, such as CPU or memory usage of the runtimes within your environment. More information on how to configure the solution architecture of your model can be found in this microlearning:
41 41  
42 -~[~[image~:Main.Images.Fundamental.WebHome@fundamental-traceability-in-emagiz~-~-data-sink-search-options.png]]
42 +* [[Crash Course Platfrom>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.Solution Architecture.WebHome||target="blank"]]
43 +* [[Crash Course Platfrom>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.Solution Architecture.WebHome||target="blank"]]
43 43  
44 -~[~[image~:Main.Images.Fundamental.WebHome@fundamental-traceability-in-emagiz~-~-data-sink-search-results.png]]
45 +== 4. Key takeaways ==
45 45  
46 -For more information on data sink please check out the following ~[~[Data sink>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.Data Management.advanced-data-management-data-sink||target="blank"]]
47 +* Each eMagiz model has a standard Manage phase in which statistics are kept on your environment
48 +* With these statistics, you can determine whether messages have been received by and sent by eMagiz
49 +* This functionality does not allow you to see the content of the messages itself
50 +* On top of that, eMagiz offers Data Sink and long term Archiving as additional licensed features
51 +* Data sink is helpful for an Ops scenario to check whether a specific message is processed by eMagiz (Traceability)
52 +* Long term archiving is helpful for legal purposes as it gives you the option to prove for seven years that a specific message is sent at a specific time (Compliancy)
47 47  
48 -However, in some cases, there are additional legal requirements you need to meet. These legal requirements require you to prove for an extended period (i.e., seven years) that a specific message was sent at a particular moment in time. For this requirement, we have the long-term archiving functionality in eMagiz.
54 +== 5. Suggested Additional Readings ==
49 49  
50 -~==== 3.3 Long Term Archiving ====
51 -
52 -The long-term archiving functionality is an expansion of the data sink functionality. By adding a specific tag to the logic within the flow, the data will be placed in the data sink and placed in our long-term archiving solution. In this solution, we will keep the data for a standard period of seven years before deleting the data from the long-term archiving solution. This allows you to retrieve chunks of data from the long-term archiving via a ticket request in our support portal. As a result, we will provide you with the requested data promptly.
53 -
54 -For more information on data sink please check out the following ~[~[Long term archiving>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.Data Management.advanced-data-management-long-term-archiving||target="blank"]]
55 -
56 -~== 4. Key takeaways ==
57 -
58 -~* Each eMagiz model has a standard Manage phase in which statistics are kept on your environment
59 -~* With these statistics, you can determine whether messages have been received by and sent by eMagiz
60 -~* This functionality does not allow you to see the content of the messages itself
61 -~* On top of that, eMagiz offers Data Sink and long term Archiving as additional licensed features
62 -~* Data sink is helpful for an Ops scenario to check whether a specific message is processed by eMagiz (Traceability)
63 -~* Long term archiving is helpful for legal purposes as it gives you the option to prove for seven years that a specific message is sent at a specific time (Compliancy)
64 -
65 -~== 5. Suggested Additional Readings ==
66 -
67 67  If you are interested in this topic and want to learn how you can control your Cloud with the help of the eMagiz platform, please check out our microlearnings offering on eMagiz Cloud Management:
68 68  
69 -~* ~[~[Crashcourse Messaging>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Messaging.crashcourse-messaging-interpreting-queue-statistics||target="blank"]]
70 -~* ~[~[Data sink>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.Data Management.advanced-data-management-data-sink||target="blank"]]
71 -~* ~[~[Long term archiving>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.Data Management.advanced-data-management-long-term-archiving||target="blank"]]
58 +* [[Crashcourse Messaging>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Messaging.crashcourse-messaging-interpreting-queue-statistics||target="blank"]]
59 +* [[Data sink>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.Data Management.advanced-data-management-data-sink||target="blank"]]
60 +* [[Long term archiving>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.Data Management.advanced-data-management-long-term-archiving||target="blank"]]
72 72  
73 -~)~)~)~(~(~(~{~{toc/}}~)~)~)~{~{/container}}~{~{/container}}
62 +)))((({{toc/}}))){{/container}}{{/container}}