Changes for page Testing in eMagiz
Last modified by Erik Bakker on 2024/08/08 11:24
From version 11.1
edited by Bouke Reitsma
on 2023/07/05 10:57
on 2023/07/05 10:57
Change comment:
There is no comment for this version
To version 3.1
edited by Bouke Reitsma
on 2023/07/05 10:36
on 2023/07/05 10:36
Change comment:
There is no comment for this version
Summary
-
Page properties (1 modified, 0 added, 0 removed)
Details
- Page properties
-
- Content
-
... ... @@ -1,47 +1,60 @@ 1 1 {{container}}{{container layoutStyle="columns"}}((( 2 - In this fundamental we discussdifferenttestingmethods available insoftwaredevelopmentanddiscusshowthesemethodscanbe usedand/or implanted withinthe platform.Testingin eMagizcanalreadybe donewithin theCreatephase andwithindeployedintegrations via theDeployandManagephases. Afterreadingthisfundamentalyou shouldbe ableto understandtheconcepts ofdifferent testingmethodsndhowthese areincorporatedwithinheeMagizplatform.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. 3 3 4 - Shouldyouhaveany questions,pleasegetin touchwith [[academy@emagiz.com>>mailto:academy@emagiz.com]].4 +All these concepts are used for Traceability & Compliancy business requirements... 5 5 6 +Should you have any questions, please get in touch with academy@emagiz.com. 7 + 6 6 == 1. Prerequisites == 7 7 8 -* BasicKnowledgeof the eMagizPlatform10 +* An overall view of the capabilities of the eMagiz platform will be helpful 9 9 10 10 == 2. Key concepts == 11 11 12 -* Unit Testing 13 -* Regression testing 14 -* Performance Testing 15 -* End-To-End Testing 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 16 16 17 -== 3. Testing in eMagiz == 18 18 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. 20 20 21 -== =3.1UnitTesting ===22 +== 3. Traceability in eMagiz == 22 22 23 - Unittestingisa common practice withinsoftwareplatforms. Usually,unittestsareperformedbydevelopersduringdevelopment.It entails testingindividualintegrationsor thecomponentswithinan integration,suchastransformations ormappings.The unit testaimsto test earlywithinthedevelopmentprocesstoidentifyand fixissuesearlybeforetheybecomemoredifficult andcostlytofindandsolve.24 +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. 24 24 25 - WithineMagiz, 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 testcommunication with externalsystems.More information on flow tests can be found in the following microlearnings:26 +=== 3.1 Queue Statistics === 26 26 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"]] 28 +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. 29 29 30 - === 3.2 RegressionTesting===30 +[[image:Main.Images.Fundamental.WebHome@fundamental-traceability-in-emagiz--queue-statistics.png]] 31 31 32 - Anothertestingmethod usedwithinsoftware developmentisregressiontesting.Regressiontestsnsurethat existingfunctionalityis notimpactedby newlydevelopedfunctionality. Runningthesetests iscrucial to preventingunexpectednegativechangesforcustomers. Regressiontestscanbe appliedondifferent levels,fromindividualfunctionalityto thewholeplatform.32 +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. 33 33 34 - Themain functionality within theeMagiz platformo perform regressiontestingonyourintegrationscalled"Automatedflowtesting."Forevery flow test, there istheoptiontoutomate them.Whenaflow testisautomated,it willrun all automated flow tests onceanew versioncommitted.If thetest fails,youwill benotified onthe flow-levelandgetaresultoverview onrelease activation. More informationcan befound inthe microlearning:34 +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"]] 35 35 36 - *[[TestingAPI Gateway>>doc:Main.eMagizAcademy.Microlearnings.IntermediateLevel.TestingineMagiz.intermediate-testing-in-emagiz-regression-testing||target="blank"]]36 +In some cases, however, more traceability is needed for Ops work. For those use cases, we have additional functionality within eMagiz called data sink. 37 37 38 -=== =3.3Performance Testing====38 +=== 3.2 Data Sink === 39 39 40 - Athird methodfortestingis theperformancetest.Within aperformance test,not thecontentisimportantbuttheamountfloadyoutest onyourtestsubject.Inthecaseofintegrations,it means,in general,thenumber of messagessentoveracertainintegration. Normallyyour productionenvironmenthandlesmore loadthana testoracceptance environment.Withaperformancetest, you canestimate how much impactnewintegrationhas onresources,such asCPU ormemory usageoftheruntimeswithinyournvironment.Moreinformationon howto configurethesolutionarchitecture ofyourmodel canbe foundin thismicrolearning:40 +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. 41 41 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"]] 42 +[[image:Main.Images.Fundamental.WebHome@fundamental-traceability-in-emagiz--data-sink-view-manage.png]] 44 44 44 +[[image:Main.Images.Fundamental.WebHome@fundamental-traceability-in-emagiz--data-sink-search-options.png]] 45 + 46 +[[image:Main.Images.Fundamental.WebHome@fundamental-traceability-in-emagiz--data-sink-search-results.png]] 47 + 48 +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"]] 49 + 50 +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. 51 + 52 +==== 3.3 Long Term Archiving ==== 53 + 54 +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. 55 + 56 +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"]] 57 + 45 45 == 4. Key takeaways == 46 46 47 47 * Each eMagiz model has a standard Manage phase in which statistics are kept on your environment