Skip to content

feat: Improvements on XUnitPublisher #268

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
beslst wants to merge 6 commits into
base: master
Choose a base branch
from
Open

feat: Improvements on XUnitPublisher #268

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
c7c8563
feat(xUnitXmlPublisher): Include assertion message in test output
stefanbesler Nov 18, 2023
e568c76
Merge remote-tracking branch 'upstream/master' into feature/xUnitXmlP…
stefanbesler Mar 26, 2025
01d00d3
Merge branch 'pr-208' into master_zgwk
beslst Jan 13, 2026
bd4eb52
feat: flush the xml file whenever the xUnitBuffer is too small
beslst Jan 13, 2026
4e0f35d
Revert "Merge branch 'pr-208' into master_zgwk"
beslst Jan 13, 2026
1717ead
chore: merge error
beslst Jan 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
113 changes: 76 additions & 37 deletions TcUnit/TcUnit/POUs/FB_XmlControl.TcPOU
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,15 @@
*)
FUNCTION_BLOCK FB_XmlControl
VAR
XmlBuffer : FB_StreamBuffer;
XmlFileStream : REFERENCE TO FB_XmlFileStream;
TagListBuffer : FB_StreamBuffer;
Tags : T_MaxString;
TagListSeekBuffer : FB_StreamBuffer;
TagsSeek : STRING;
TagBuffer : FB_StreamBuffer;
Tag : T_MaxString;
TagOpen: BOOL;
TagOpenCount : INT;
Select : UDINT;
SearchPosition : UDINT;
END_VAR
Expand All @@ -32,6 +33,10 @@ VAR CONSTANT
TAB : STRING(2) := '$T';
CR_LF : STRING(4) := '$R$N';

CR_AS_BYTE : BYTE := 13;
LF_AS_BYTE : BYTE := 10;
SPACE_AS_BYTE : BYTE := 32;

// $OD : ASCII code for carriage return (CR)
// $$ : to add a $R
// $' : to add ' (apostrophe)
Expand All @@ -43,13 +48,34 @@ END_VAR]]></Declaration>
<Implementation>
<ST><![CDATA[]]></ST>
</Implementation>
<Method Name="AppendIdent" Id="{703b348d-6c3f-0f37-18f0-541fdcc34c87}">
<Declaration><![CDATA[METHOD PRIVATE AppendIdent
VAR_INST
indentBuffer : T_MaxString;
i : INT;
end : INT;
END_VAR
]]></Declaration>
<Implementation>
<ST><![CDATA[indentBuffer[0] := CR_AS_BYTE;
indentBuffer[1] := LF_AS_BYTE;

FOR i:=2 TO TagOpenCount
DO
indentBuffer[i] := SPACE_AS_BYTE;
END_FOR
indentBuffer[TagOpenCount+2] := 0;

XmlFileStream.Append := indentBuffer;]]></ST>
</Implementation>
</Method>
<Method Name="ClearBuffer" Id="{651b4460-232e-47e8-95ba-ecea1541fbb9}">
<Declaration><![CDATA[// Clears the contents of the entire buffer.
METHOD PUBLIC ClearBuffer]]></Declaration>
<Implementation>
<ST><![CDATA[SearchPosition := 0;
TagListSeekBuffer.Length := 0;
XmlBuffer.Length := 0;
XmlFileStream.Length := 0;
TagsSeek := '';
Tag := '';]]></ST>
</Implementation>
Expand All @@ -66,28 +92,50 @@ VAR
ClosedTag : T_MaxString;
END_VAR]]></Declaration>
<Implementation>
<ST><![CDATA[IF TagOpen THEN
XmlBuffer.Append := END_TAG_CLOSE;
<ST><![CDATA[TagOpenCount := TagOpenCount - 1;

IF TagOpen THEN
XmlFileStream.Append := END_TAG_CLOSE;
Select := TagListBuffer.FindBack(SearchString := FORWARD_SLASH);
ClosedTag := TagListBuffer.CutOff(StartPos := Select);
TagOpen := FALSE;
ELSE
AppendIdent();
Select := TagListBuffer.FindBack(SearchString := FORWARD_SLASH);
ClosedTag := TagListBuffer.CutOff(StartPos := Select);
XmlBuffer.Append := TAG_OPEN;
XmlBuffer.Append := ClosedTag;
XmlBuffer.Append := TAG_CLOSE;
XmlFileStream.Append := TAG_OPEN;
XmlFileStream.Append := ClosedTag;
XmlFileStream.Append := TAG_CLOSE;
END_IF

CloseTag := ClosedTag;]]></ST>
</Implementation>
</Method>
<Method Name="FB_Init" Id="{5c27080a-297f-0999-167e-85f86bcdacd9}">
<Declaration><![CDATA[//FB_Init is always available implicitly and it is used primarily for initialization.
//The return value is not evaluated. For a specific influence, you can also declare the
//methods explicitly and provide additional code there with the standard initialization
//code. You can evaluate the return value.
METHOD FB_Init: BOOL
VAR_INPUT
bInitRetains: BOOL; // TRUE: the retain variables are initialized (reset warm / reset cold)
bInCopyCode: BOOL; // TRUE: the instance will be copied to the copy code afterward (online change)
xmlFileStream : REFERENCE TO FB_XmlFileStream;
END_VAR]]></Declaration>
<Implementation>
<ST><![CDATA[THIS^.XmlFileStream REF= xmlFileStream;

TagListBuffer.SetBuffer(PointerToBufferAddress := ADR(Tags), SizeOfBuffer := SIZEOF(Tags));
TagListSeekBuffer.SetBuffer(PointerToBufferAddress := ADR(TagsSeek), SizeOfBuffer := SIZEOF(TagsSeek));
TagBuffer.SetBuffer(PointerToBufferAddress := ADR(Tag), SizeOfBuffer := SIZEOF(Tag));]]></ST>
</Implementation>
</Method>
<Property Name="Length" Id="{4fdf30b6-5fe7-4452-ad0a-85e866e236d0}">
<Declaration><![CDATA[PROPERTY Length : UDINT]]></Declaration>
<Get Name="Get" Id="{267105d4-b124-4c5c-a359-0434c4992afc}">
<Declaration><![CDATA[]]></Declaration>
<Implementation>
<ST><![CDATA[Length := XmlBuffer.Length;]]></ST>
<ST><![CDATA[Length := XmlFileStream.Length;]]></ST>
</Implementation>
</Get>
</Property>
Expand All @@ -104,12 +152,12 @@ VAR_INPUT
END_VAR]]></Declaration>
<Implementation>
<ST><![CDATA[IF TagOpen THEN
XmlBuffer.Append := TAG_CLOSE;
XmlFileStream.Append := TAG_CLOSE;
TagOpen := FALSE;
END_IF;
XmlBuffer.Append := OPEN_COMMENT;
XmlBuffer.Append := Comment;
XmlBuffer.Append := CLOSE_COMMENT;]]></ST>
XmlFileStream.Append := OPEN_COMMENT;
XmlFileStream.Append := Comment;
XmlFileStream.Append := CLOSE_COMMENT;]]></ST>
</Implementation>
</Method>
<Method Name="NewParameter" Id="{60c10606-ff09-4f9b-a3dd-0b54d0f565c7}">
Expand All @@ -124,12 +172,12 @@ VAR_INPUT
Value : T_MaxString;
END_VAR]]></Declaration>
<Implementation>
<ST><![CDATA[XmlBuffer.Append := SPACE;
XmlBuffer.Append := Name;
XmlBuffer.Append := EQUALS;
XmlBuffer.Append := QUOTE;
XmlBuffer.Append := Value;
XmlBuffer.Append := QUOTE;]]></ST>
<ST><![CDATA[XmlFileStream.Append := SPACE;
XmlFileStream.Append := Name;
XmlFileStream.Append := EQUALS;
XmlFileStream.Append := QUOTE;
XmlFileStream.Append := Value;
XmlFileStream.Append := QUOTE;]]></ST>
</Implementation>
</Method>
<Method Name="NewTag" Id="{c44bdbda-725a-4943-a5cc-fa5ea9485541}">
Expand All @@ -145,10 +193,14 @@ VAR_INPUT
END_VAR]]></Declaration>
<Implementation>
<ST><![CDATA[IF TagOpen THEN
XmlBuffer.Append := TAG_CLOSE;
XmlFileStream.Append := TAG_CLOSE;
END_IF;
XmlBuffer.Append := TAG_OPEN;
XmlBuffer.Append := Name;

TagOpenCount := TagOpenCount + 1;
AppendIdent();

XmlFileStream.Append := TAG_OPEN;
XmlFileStream.Append := Name;
TagOpen := TRUE;
TagListBuffer.Append := FORWARD_SLASH;
TagListBuffer.Append := Name;]]></ST>
Expand All @@ -160,24 +212,11 @@ VAR_INPUT
Data : T_MaxString;
END_VAR]]></Declaration>
<Implementation>
<ST><![CDATA[XmlBuffer.Append := TAG_CLOSE;
XmlBuffer.Append := Data;
<ST><![CDATA[XmlFileStream.Append := TAG_CLOSE;
XmlFileStream.Append := Data;
TagOpen := FALSE;]]></ST>
</Implementation>
</Method>
<Method Name="SetBuffer" Id="{cbfaa6d5-eab9-48d0-a339-a8bf334e344e}">
<Declaration><![CDATA[METHOD PUBLIC SetBuffer
VAR_INPUT
PointerToBuffer : POINTER TO BYTE; // ADR(..)
SizeOfBuffer : UDINT; // SIZEOF(..)
END_VAR]]></Declaration>
<Implementation>
<ST><![CDATA[XmlBuffer.SetBuffer(PointerToBufferAddress:= PointerToBuffer, SizeOfBuffer := SizeOfBuffer);
TagListBuffer.SetBuffer(PointerToBufferAddress := ADR(Tags), SizeOfBuffer := SIZEOF(Tags));
TagListSeekBuffer.SetBuffer(PointerToBufferAddress := ADR(TagsSeek), SizeOfBuffer := SIZEOF(TagsSeek));
TagBuffer.SetBuffer(PointerToBufferAddress := ADR(Tag), SizeOfBuffer := SIZEOF(Tag));]]></ST>
</Implementation>
</Method>
<Method Name="ToStartBuffer" Id="{cb065068-a6c8-48d5-8c1d-535a21365348}">
<Declaration><![CDATA[(*
Jump to the beginning of the XML data
Expand Down Expand Up @@ -205,7 +244,7 @@ VAR_INPUT
Header : T_MaxString;
END_VAR]]></Declaration>
<Implementation>
<ST><![CDATA[XmlBuffer.Append := Header;]]></ST>
<ST><![CDATA[XmlFileStream.Append := Header;]]></ST>
</Implementation>
</Method>
</POU>
Expand Down
102 changes: 102 additions & 0 deletions TcUnit/TcUnit/POUs/FB_XmlFileStream.TcPOU
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,102 @@
<?xml version="1.0" encoding="utf-8"?>
<TcPlcObject Version="1.1.0.1">
<POU Name="FB_XmlFileStream" Id="{b70f94c8-92d2-0070-29bb-d87672ff0479}" SpecialFunc="None">
<Declaration><![CDATA[// This functionblock acts as a stream buffer for use with FB_XmlControl
FUNCTION_BLOCK FB_XmlFileStream EXTENDS FB_StreamBuffer
VAR
File : FB_FileControl;

BufferInitialised : BOOL := FALSE;
Buffer : ARRAY [0..(GVL_Param_TcUnit.XUnitBufferSize - 1)] OF BYTE;
END_VAR]]></Declaration>
<Implementation>
<ST><![CDATA[]]></ST>
</Implementation>
<Property Name="Append" Id="{ff5c19dd-debd-0c1d-3634-191a3290559b}">
<Declaration><![CDATA[// Appends a string to the buffer
PROPERTY Append : T_MaxString]]></Declaration>
<Set Name="Set" Id="{ad8559ea-2d50-0888-106e-f6ce935a7509}">
<Declaration><![CDATA[VAR
ByteIn : POINTER TO BYTE;
ByteBuffer : POINTER TO BYTE;
END_VAR]]></Declaration>
<Implementation>
<ST><![CDATA[ByteIn := ADR(Append);
ByteBuffer := _PointerToStringBuffer + _Length; // set start address

REPEAT

WHILE ByteIn^ <> 0 AND _Length < _BufferSize DO
ByteBuffer^ := ByteIn^; //Copy the 1st byte
_Length := _Length + 1; // set new buffer length
ByteIn := ByteIn + 1; // calculate new start address
ByteBuffer := ByteBuffer + 1; // calculate new start address
END_WHILE;

IF ByteIn^ <> 0
THEN
Flush();
Clear();
ByteBuffer := _PointerToStringBuffer;
END_IF

UNTIL ByteIn^ = 0 END_REPEAT

ByteBuffer := _PointerToStringBuffer + _Length; // String End
ByteBuffer^ := 0; // null terminated string]]></ST>
</Implementation>
</Set>
</Property>
<Method Name="CloseFile" Id="{506f243e-65c2-0bad-27d2-c84f4b235bbd}">
<Declaration><![CDATA[(*
Deletes the former file (if it exists).
Opens the file, writes the buffer and closes it.
*)
METHOD CloseFile : SysFile.SysTypes.RTS_IEC_RESULT;]]></Declaration>
<Implementation>
<ST><![CDATA[CloseFile := SysDir.CmpErrors.Errors.ERR_OK;
CloseFile := MAX(CloseFile, Flush());
CloseFile := MAX(CloseFile, File.Close());]]></ST>
</Implementation>
</Method>
<Method Name="CreateFile" Id="{6244f4a5-e898-0ddb-089d-bad22f5a92db}">
<Declaration><![CDATA[(*
Deletes the former file (if it exists).
Opens the file, writes the buffer and closes it.
*)
METHOD CreateFile : SysFile.SysTypes.RTS_IEC_RESULT;]]></Declaration>
<Implementation>
<ST><![CDATA[CreateFile := SysDir.CmpErrors.Errors.ERR_OK;
CreateFile := MAX(CreateFile, File.Delete(Filename := GVL_Param_TcUnit.xUnitFilePath));
CreateFile := MAX(CreateFile, File.Open(Filename := GVL_Param_TcUnit.xUnitFilePath, FileAccessMode := ACCESS_MODE.AM_WRITE_PLUS));]]></ST>
</Implementation>
</Method>
<Method Name="FB_init" Id="{0874c850-d713-0321-28cd-b342f2f30134}">
<Declaration><![CDATA[//FB_Init is always available implicitly and it is used primarily for initialization.
//The return value is not evaluated. For a specific influence, you can also declare the
//methods explicitly and provide additional code there with the standard initialization
//code. You can evaluate the return value.
METHOD FB_Init: BOOL
VAR_INPUT
bInitRetains: BOOL; // TRUE: the retain variables are initialized (reset warm / reset cold)
bInCopyCode: BOOL; // TRUE: the instance will be copied to the copy code afterward (online change)
END_VAR]]></Declaration>
<Implementation>
<ST><![CDATA[SetBuffer(ADR(Buffer), GVL_Param_TcUnit.XUnitBufferSize);]]></ST>
</Implementation>
</Method>
<Method Name="Flush" Id="{d06eec93-628a-0aa6-0431-7060901a9f4e}">
<Declaration><![CDATA[(*
Deletes the former file (if it exists).
Opens the file, writes the buffer and closes it.
*)
METHOD PRIVATE Flush : SysFile.SysTypes.RTS_IEC_RESULT;]]></Declaration>
<Implementation>
<ST><![CDATA[Flush := SysDir.CmpErrors.Errors.ERR_OK;
Flush := MAX(Flush, File.Write(_PointerToStringBuffer, _Length));
Flush := MAX(Flush, File.Close());
Flush := MAX(Flush, File.Open(Filename := GVL_Param_TcUnit.xUnitFilePath, FileAccessMode := ACCESS_MODE.AM_APPEND_PLUS));]]></ST>
</Implementation>
</Method>
</POU>
</TcPlcObject>
Loading