chore(examples/[no ci): Add examples

TcHaxx · Feb 11, 2024 · 9b987f5 · 9b987f5
1 parent df48f25
commit 9b987f5
Show file tree

Hide file tree

Showing 11 changed files with 127 additions and 27 deletions.
diff --git a/README.md b/README.md
@@ -13,6 +13,37 @@ During the assertion phase, Snappy performs the following steps:
 This discrepancy could indicate either an unexpected change or the need to update the reference snapshot to reflect the new result
 4. The validated files can the be added to [source control](#source-control-received-and-verified-files).
 
+
+## Example using `TcUnit`
+```
+FUNCTION_BLOCK FB_TcUnitExample EXTENDS FB_TestSuite
+VAR
+	hr				: HRESULT;		
+	fbTcUnitAdapter : FB_TcUnitAdapter;
+	
+	stActual		: ST_DemoDataType;
+	{attribute 'analysis' := '-33'}
+	stResult		: ST_VerificationResult;
+END_VAR
+```
+```
+TEST('Test some stuff with TcHaxx.Snappy');
+
+// ARRANGE
+
+// ACT
+stActual := F_CreateDemoData();
+
+// ASSERT
+hr := fbTcUnitAdapter.Verify(anyArg:= stActual);
+
+IF NOT PENDING(hr) THEN
+	TEST_FINISHED_NAMED('Test some stuff with TcHaxx.Snappy');
+END_IF;
+```
+
+> Find more examples in the `examples` PLC project.
+
 ## Install
 
 Snappy consists of two parts:

diff --git a/examples/examples/.snappy-verified/MyTestSuiteName.MyTestName.verified.txt b/examples/examples/.snappy-verified/MyTestSuiteName.MyTestName.verified.txt
@@ -1,7 +1,7 @@
 {
   sString: Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy,
   nNumber: 3735928559,
-  nFloat: -1.2345678,
+  fFloat: -1.2345678,
   aBuffer: [
     1,
     2,
@@ -16,7 +16,7 @@
     11,
     12,
     13,
-    12,
+    14,
     15,
     16
   ]

diff --git a/...nappy.examples.PRG_TcUnit.fbTcunitExample.Test some stuff with TcHaxx.Snappy.verified.txt b/...nappy.examples.PRG_TcUnit.fbTcunitExample.Test some stuff with TcHaxx.Snappy.verified.txt
@@ -0,0 +1,23 @@
+{
+  sString: Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy,
+  nNumber: 3735928559,
+  fFloat: -1.2345678,
+  aBuffer: [
+    1,
+    2,
+    3,
+    4,
+    5,
+    6,
+    7,
+    8,
+    9,
+    10,
+    11,
+    12,
+    13,
+    14,
+    15,
+    16
+  ]
+}
diff --git a/examples/examples/DUTs/ST_DemoDataType.TcDUT b/examples/examples/DUTs/ST_DemoDataType.TcDUT
@@ -5,7 +5,7 @@
 STRUCT
 	sString	: STRING;
 	nNumber : UDINT;
-	nFloat	: REAL;
+	fFloat	: REAL;
 	aBuffer : ARRAY[0..15] OF BYTE;
 END_STRUCT
 END_TYPE

diff --git a/examples/examples/POUs/FB_TcUnitExample.TcPOU b/examples/examples/POUs/FB_TcUnitExample.TcPOU
@@ -2,33 +2,28 @@
 <TcPlcObject Version="1.1.0.1" ProductVersion="3.1.4024.12">
   <POU Name="FB_TcUnitExample" Id="{2328aed7-3c8d-44a5-a37e-d87d39d21ab0}" SpecialFunc="None">
     <Declaration><![CDATA[FUNCTION_BLOCK FB_TcUnitExample EXTENDS FB_TestSuite
-VAR_INPUT
-END_VAR
-VAR_OUTPUT
-END_VAR
 VAR
 	hr				: HRESULT;		
 	fbTcUnitAdapter : FB_TcUnitAdapter;
 	
-	stDemoDT		: ST_DemoDataType;
+	stActual		: ST_DemoDataType;
 	{attribute 'analysis' := '-33'}
 	stResult		: ST_VerificationResult;
 END_VAR
 ]]></Declaration>
     <Implementation>
-      <ST><![CDATA[
-TEST('Test some stuff');
+      <ST><![CDATA[TEST('Test some stuff with TcHaxx.Snappy');
 
 // ARRANGE
-stDemoDT := F_CreateDemoData();
 
 // ACT
+stActual := F_CreateDemoData();
 
 // ASSERT
-hr := fbTcUnitAdapter.Verify(anyArg:= stDemoDT);
+hr := fbTcUnitAdapter.Verify(anyArg:= stActual);
 
 IF NOT PENDING(hr) THEN
-	TEST_FINISHED_NAMED('Test some stuff');
+	TEST_FINISHED_NAMED('Test some stuff with TcHaxx.Snappy');
 END_IF;]]></ST>
     </Implementation>
   </POU>

diff --git a/examples/examples/POUs/FB_TcUnitWithoutSnappyExample.TcPOU b/examples/examples/POUs/FB_TcUnitWithoutSnappyExample.TcPOU
@@ -0,0 +1,43 @@
+<?xml version="1.0" encoding="utf-8"?>
+<TcPlcObject Version="1.1.0.1" ProductVersion="3.1.4024.12">
+  <POU Name="FB_TcUnitWithoutSnappyExample" Id="{43b4abf0-a389-4bd6-9155-50172d18c287}" SpecialFunc="None">
+    <Declaration><![CDATA[FUNCTION_BLOCK FB_TcUnitWithoutSnappyExample EXTENDS FB_TestSuite
+VAR	
+	stActual		: ST_DemoDataType;
+	stActual2		: ST_DemoDataType;
+END_VAR
+VAR CONSTANT
+	cStringExpected : STRING := 'Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy';
+	cBufferExpected : ARRAY[0..15] OF BYTE := [1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16];
+END_VAR
+]]></Declaration>
+    <Implementation>
+      <ST><![CDATA[
+TEST('Test some stuff without TcHaxx.Snappy');
+
+// ARRANGE
+
+// ACT
+stActual := F_CreateDemoData();
+
+// ASSERT
+AssertEquals_STRING(Expected:= cStringExpected,
+					Actual:= stActual.sString,
+					Message:= 'Field sString differs.');
+AssertEquals_UDINT(Expected:= 16#DEADBEEF,
+					Actual:= stActual.nNumber,
+					Message:= 'Field nNumber differs.');
+AssertEquals_REAL(Expected:= -1.23456789,
+					Actual:= stActual.fFloat,
+					Delta:= 0.00001,
+					Message:= 'Field fFloat differs.');
+AssertArrayEquals_BYTE(Expecteds:= cBufferExpected,
+						Actuals:= stActual.aBuffer,
+						Message:= 'Field aBuffer differs.');
+stActual2 := stActual;						
+stActual2.aBuffer[3]:= 55;
+AssertEquals(stActual2, stActual, 'Oh snap!');						
+TEST_FINISHED_NAMED('Test some stuff without TcHaxx.Snappy');]]></ST>
+    </Implementation>
+  </POU>
+</TcPlcObject>
diff --git a/examples/examples/POUs/F_CreateDemoData.TcPOU b/examples/examples/POUs/F_CreateDemoData.TcPOU
@@ -9,7 +9,7 @@ VAR
 END_VAR
 ]]></Declaration>
     <Implementation>
-      <ST><![CDATA[F_CreateDemoData.nFloat := -1.23456789;
+      <ST><![CDATA[F_CreateDemoData.fFloat := -1.23456789;
 F_CreateDemoData.nNumber := 16#DEADBEEF;
 F_CreateDemoData.sString := 'Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy';
 FOR i:= 0 TO SIZEOF(F_CreateDemoData.aBuffer) DO

diff --git a/examples/examples/POUs/PRG_TcUnit.TcPOU b/examples/examples/POUs/PRG_TcUnit.TcPOU
@@ -5,6 +5,7 @@
 PROGRAM PRG_TcUnit
 VAR
 	fbTcunitExample : FB_TcUnitExample;
+	fbNoSnappy		: FB_TcUnitWithoutSnappyExample;
 END_VAR
 ]]></Declaration>
     <Implementation>

diff --git a/examples/examples/examples.plcproj b/examples/examples/examples.plcproj
@@ -38,6 +38,9 @@
     <Compile Include="POUs\FB_TcUnitExample.TcPOU">
       <SubType>Code</SubType>
     </Compile>
+    <Compile Include="POUs\FB_TcUnitWithoutSnappyExample.TcPOU">
+      <SubType>Code</SubType>
+    </Compile>
     <Compile Include="POUs\F_CreateDemoData.TcPOU">
       <SubType>Code</SubType>
     </Compile>
@@ -88,8 +91,8 @@
   <ProjectExtensions>
     <PlcProjectOptions>
       <XmlArchive>
-  <Data>
-    <o xml:space="preserve" t="OptionKey">
+        <Data>
+          <o xml:space="preserve" t="OptionKey">
       <v n="Name">"&lt;ProjectRoot&gt;"</v>
       <d n="SubKeys" t="Hashtable" ckt="String" cvt="OptionKey">
         <v>{192FAD59-8248-4824-A8DE-9177C94C195A}</v>
@@ -178,14 +181,14 @@
       </d>
       <d n="Values" t="Hashtable" />
     </o>
-  </Data>
-  <TypeList>
-    <Type n="Boolean">System.Boolean</Type>
-    <Type n="Hashtable">System.Collections.Hashtable</Type>
-    <Type n="OptionKey">{54dd0eac-a6d8-46f2-8c27-2f43c7e49861}</Type>
-    <Type n="String">System.String</Type>
-  </TypeList>
-</XmlArchive>
+        </Data>
+        <TypeList>
+          <Type n="Boolean">System.Boolean</Type>
+          <Type n="Hashtable">System.Collections.Hashtable</Type>
+          <Type n="OptionKey">{54dd0eac-a6d8-46f2-8c27-2f43c7e49861}</Type>
+          <Type n="String">System.String</Type>
+        </TypeList>
+      </XmlArchive>
     </PlcProjectOptions>
   </ProjectExtensions>
 </Project>
diff --git a/src/TcHaxx.Snappy/TcHaxx.Snappy.tsproj b/src/TcHaxx.Snappy/TcHaxx.Snappy.tsproj
@@ -95,12 +95,16 @@
 					</Variant>
 					<Variant>
 						<Name>LIB</Name>
+						<Disable>0</Disable>
+						<Defines></Defines>
+					</Variant>
+					<Variant>
 						<Name>UNIT_TEST</Name>
 						<Disable>0</Disable>
 						<Defines/>
 					</Variant>
 				</ProjectVariant>
-				<Instance Id="#x08502000" TcSmClass="TComPlcObjDef" KeepUnrestoredLinks="2" TmcPath="snappy\snappy.tmc" TmcHash="{934AA734-D6F0-B942-FF86-A5DF414A8682}">
+				<Instance Id="#x08502000" TcSmClass="TComPlcObjDef" KeepUnrestoredLinks="2" TmcPath="snappy\snappy.tmc" TmcHash="{724D2834-43F6-6772-1E35-993D38D07869}">
 					<Name>snappy Instance</Name>
 					<CLSID ClassFactory="TcPlc30">{08500001-0000-0000-F000-000000000064}</CLSID>
 					<Contexts>

diff --git a/src/TcHaxx.Snappy/_Config/PLC/examples.xti b/src/TcHaxx.Snappy/_Config/PLC/examples.xti
@@ -5,7 +5,7 @@
 			<Variant>
 				<Name>EXAMPLES</Name>
 				<Disable>0</Disable>
-				<Defines/>
+				<Defines></Defines>
 			</Variant>
 			<Variant>
 				<Name>LIB</Name>
@@ -14,7 +14,7 @@
 				<Defines/>
 			</Variant>
 		</ProjectVariant>
-		<Instance Id="#x08502080" TcSmClass="TComPlcObjDef" KeepUnrestoredLinks="2" TmcPath="..\..\examples\examples\examples.tmc" TmcHash="{E2F6A659-B1F9-2F24-31B0-69C562451188}">
+		<Instance Id="#x08502080" TcSmClass="TComPlcObjDef" KeepUnrestoredLinks="2" TmcPath="..\..\examples\examples\examples.tmc" TmcHash="{48A3FC13-FA74-F622-EB16-F0E26A79BE42}">
 			<Name>examples Instance</Name>
 			<CLSID ClassFactory="TcPlc30">{08500001-0000-0000-F000-000000000064}</CLSID>
 			<Contexts>