test_gsdml.cpp

Go to the documentation of this file.

 
 
#include <gtest/gtest.h>
 
#include <filesystem>
#include <fstream>
#include <string>
#include <tuple>
#include <vector>
 
#include "profinet/gsdml.h"
 
namespace profinet::gsdml
{
 
namespace
{
 
// =============================================================================
// Test fixtures
// =============================================================================
 
constexpr const char* MINIMAL_GSDML = R"xml(
<ISO15745Profile>
  <ProfileBody>
    <DeviceIdentity VendorID="0x002A" DeviceID="0x0003"/>
    <DeviceFunction>
      <Name Value="Test Device"/>
    </DeviceFunction>
    <ApplicationProcess>
      <DeviceAccessPointList>
        <DeviceAccessPointItem ID="DAP_1"
                               ModuleIdentNumber="0x00000001"
                               SubmoduleIdentNumber="0x00000001">
          <SystemDefinedSubmoduleList>
            <InterfaceSubmoduleItem
                Subslot="0x8000"
                SubmoduleIdentNumber="0x00000100"/>
            <PortSubmoduleItem
                Subslot="0x8001"
                SubmoduleIdentNumber="0x00000200"/>
          </SystemDefinedSubmoduleList>
          <VirtualSubmoduleList>
            <VirtualSubmoduleItem ID="DAP_Sub"
                                   SubmoduleIdentNumber="0x00000001">
              <IOData>
                <Input>
                  <DataItem DataType="Unsigned8"/>
                </Input>
              </IOData>
            </VirtualSubmoduleItem>
          </VirtualSubmoduleList>
          <UseableModules>
            <ModuleItemRef ModuleItemTarget="MOD_INPUT"
                           AllowedInSlots="1..5"/>
            <ModuleItemRef ModuleItemTarget="MOD_OUTPUT"
                           AllowedInSlots="1..5"/>
          </UseableModules>
          <PredefinedPnioModules>
            <PnioModuleItemRef ModuleItemTarget="MOD_INPUT"
                               FixedInSlots="1"/>
            <PnioModuleItemRef ModuleItemTarget="MOD_OUTPUT"
                               FixedInSlots="2"/>
          </PredefinedPnioModules>
        </DeviceAccessPointItem>
      </DeviceAccessPointList>
      <ModuleList>
        <ModuleItem ID="MOD_INPUT"
                    ModuleIdentNumber="0x00000010">
          <VirtualSubmoduleList>
            <VirtualSubmoduleItem ID="MOD_IN_Sub"
                                   SubmoduleIdentNumber="0x00000001">
              <IOData>
                <Input>
                  <DataItem DataType="OctetString" Length="4"/>
                </Input>
              </IOData>
            </VirtualSubmoduleItem>
          </VirtualSubmoduleList>
        </ModuleItem>
        <ModuleItem ID="MOD_OUTPUT"
                    ModuleIdentNumber="0x00000020">
          <VirtualSubmoduleList>
            <VirtualSubmoduleItem ID="MOD_OUT_Sub"
                                   SubmoduleIdentNumber="0x00000001">
              <IOData>
                <Output>
                  <DataItem DataType="Unsigned16"/>
                </Output>
              </IOData>
            </VirtualSubmoduleItem>
          </VirtualSubmoduleList>
        </ModuleItem>
      </ModuleList>
    </ApplicationProcess>
  </ProfileBody>
</ISO15745Profile>
)xml";
 
constexpr const char* NAMESPACED_GSDML = R"xml(
<ISO15745Profile xmlns="http://www.profibus.com/GSDML/2.4">
  <ProfileBody>
    <DeviceIdentity VendorID="0x0042" DeviceID="0x0007"/>
    <ApplicationProcess>
      <DeviceAccessPointList>
        <DeviceAccessPointItem ID="DAP_NS"
                               ModuleIdentNumber="0x00000002"
                               SubmoduleIdentNumber="0x00000001">
          <VirtualSubmoduleList>
            <VirtualSubmoduleItem ID="Sub1"
                                   SubmoduleIdentNumber="0x00000001">
              <IOData>
                <Input>
                  <DataItem DataType="Unsigned32"/>
                </Input>
              </IOData>
            </VirtualSubmoduleItem>
          </VirtualSubmoduleList>
        </DeviceAccessPointItem>
      </DeviceAccessPointList>
      <ModuleList>
        <ModuleItem ID="MOD_A"
                    ModuleIdentNumber="0x000000AA">
          <VirtualSubmoduleList>
            <VirtualSubmoduleItem ID="MOD_A_Sub"
                                   SubmoduleIdentNumber="0x00000001">
              <IOData>
                <Output>
                  <DataItem DataType="Float32"/>
                </Output>
              </IOData>
            </VirtualSubmoduleItem>
          </VirtualSubmoduleList>
        </ModuleItem>
      </ModuleList>
    </ApplicationProcess>
  </ProfileBody>
</ISO15745Profile>
)xml";
 
constexpr const char* DATA_TYPES_GSDML = R"xml(
<ISO15745Profile>
  <ProfileBody>
    <DeviceIdentity VendorID="42" DeviceID="7"/>
    <ApplicationProcess>
      <DeviceAccessPointList>
        <DeviceAccessPointItem ID="DAP"
                               ModuleIdentNumber="1"
                               SubmoduleIdentNumber="1">
          <VirtualSubmoduleList>
            <VirtualSubmoduleItem ID="DATA"
                                   SubmoduleIdentNumber="1">
              <IOData>
                <Input>
                  <DataItem DataType="Unsigned8"/>
                  <DataItem DataType="Unsigned16"/>
                  <DataItem DataType="Unsigned32"/>
                  <DataItem DataType="Float32"/>
                  <DataItem DataType="Float64"/>
                  <DataItem DataType="Integer16"/>
                  <DataItem DataType="Boolean"/>
                  <DataItem DataType="OctetString" Length="10"/>
                  <DataItem DataType="VisibleString" Length="32"/>
                </Input>
              </IOData>
            </VirtualSubmoduleItem>
          </VirtualSubmoduleList>
        </DeviceAccessPointItem>
      </DeviceAccessPointList>
      <ModuleList/>
    </ApplicationProcess>
  </ProfileBody>
</ISO15745Profile>
)xml";
 
class GsdmlTest : public ::testing::Test
{
 protected:
  static GSDMLDevice Parse(const std::string& xml)
  {
    return ParseGsdmlString(xml);
  }
 
  static const rpc::IOSlot& FindSlot(const std::vector<rpc::IOSlot>& slots,
                                     std::uint16_t slot,
                                     std::uint16_t subslot)
  {
    for (const auto& value : slots)
    {
      if (value.slot == slot && value.subslot == subslot)
      {
        return value;
      }
    }
 
    ADD_FAILURE() << "Slot " << slot << ":" << subslot << " was not found";
    return slots.front();
  }
 
  static std::vector<rpc::IOSlot> FindSlots(const std::vector<rpc::IOSlot>& slots,
                                            std::uint16_t slot)
  {
    std::vector<rpc::IOSlot> result;
 
    for (const auto& value : slots)
    {
      if (value.slot == slot)
      {
        result.push_back(value);
      }
    }
 
    return result;
  }
};
 
// =============================================================================
// Data item / IOData tests
// =============================================================================
 
TEST_F(GsdmlTest, Unsigned8HasLengthOne)
{
  const auto dev = Parse(R"xml(
<ISO15745Profile>
  <ProfileBody>
    <DeviceIdentity VendorID="1" DeviceID="2"/>    
    <ApplicationProcess>
      <DeviceAccessPointList>
        <DeviceAccessPointItem ID="DAP" ModuleIdentNumber="1">
          <VirtualSubmoduleList>
            <VirtualSubmoduleItem ID="S" SubmoduleIdentNumber="1">
              <IOData>
                <Input>
                  <DataItem DataType="Unsigned8"/>
                </Input>
              </IOData>
            </VirtualSubmoduleItem>
          </VirtualSubmoduleList>          
        </DeviceAccessPointItem>
      </DeviceAccessPointList>
    </ApplicationProcess>
  </ProfileBody>
</ISO15745Profile>
)xml");
 
  const auto slots = dev.BuildIoSlots();
 
  EXPECT_EQ(slots.size(), 1U);
  EXPECT_EQ(slots[0].inputLength, 1U);
  EXPECT_EQ(slots[0].outputLength, 0U);
}
 
TEST_F(GsdmlTest, Unsigned16HasLengthTwo)
{
  const auto dev = Parse(R"xml(
<ISO15745Profile>
  <ProfileBody>
    <DeviceIdentity VendorID="1" DeviceID="2"/>        
    <ApplicationProcess>
      <DeviceAccessPointList>
        <DeviceAccessPointItem ID="DAP" ModuleIdentNumber="1">
          <VirtualSubmoduleList>
            <VirtualSubmoduleItem ID="S" SubmoduleIdentNumber="1">
              <IOData>
                <Input>
                  <DataItem DataType="Unsigned16"/>
                </Input>
              </IOData>
            </VirtualSubmoduleItem>
          </VirtualSubmoduleList>          
        </DeviceAccessPointItem>
      </DeviceAccessPointList>
    </ApplicationProcess>
  </ProfileBody>
</ISO15745Profile>
)xml");
 
  const auto slots = dev.BuildIoSlots();
 
  ASSERT_EQ(slots.size(), 1U);
  EXPECT_EQ(slots[0].inputLength, 2U);
}
 
TEST_F(GsdmlTest, Unsigned32HasLengthFour)
{
  const auto dev = Parse(R"xml(
<ISO15745Profile>
  <ProfileBody>
    <DeviceIdentity VendorID="1" DeviceID="2"/>        
    <ApplicationProcess>
      <DeviceAccessPointList>
        <DeviceAccessPointItem ID="DAP" ModuleIdentNumber="1">
          <VirtualSubmoduleList>
            <VirtualSubmoduleItem ID="S" SubmoduleIdentNumber="1">
              <IOData>
                <Output>
                  <DataItem DataType="Unsigned32"/>
                </Output>
              </IOData>
            </VirtualSubmoduleItem>
          </VirtualSubmoduleList>
        </DeviceAccessPointItem>
      </DeviceAccessPointList>
    </ApplicationProcess>
  </ProfileBody>
</ISO15745Profile>
)xml");
 
  const auto slots = dev.BuildIoSlots();
 
  ASSERT_EQ(slots.size(), 1U);
  EXPECT_EQ(slots[0].outputLength, 4U);
}
 
TEST_F(GsdmlTest, Float32HasLengthFour)
{
  const auto dev = Parse(R"xml(
<ISO15745Profile>
  <ProfileBody>
    <DeviceIdentity VendorID="1" DeviceID="2"/>            
    <ApplicationProcess>
      <DeviceAccessPointList>
        <DeviceAccessPointItem ID="DAP" ModuleIdentNumber="1">
          <VirtualSubmoduleList>
            <VirtualSubmoduleItem ID="S" SubmoduleIdentNumber="1">
              <IOData>
                <Input>
                  <DataItem DataType="Float32"/>
                </Input>
              </IOData>
            </VirtualSubmoduleItem>
          </VirtualSubmoduleList>
        </DeviceAccessPointItem>
      </DeviceAccessPointList>
    </ApplicationProcess>
  </ProfileBody>
</ISO15745Profile>
)xml");
 
  const auto slots = dev.BuildIoSlots();
 
  ASSERT_EQ(slots.size(), 1U);
  EXPECT_EQ(slots[0].inputLength, 4U);
}
 
TEST_F(GsdmlTest, Float64HasLengthEight)
{
  const auto dev = Parse(R"xml(
<ISO15745Profile>
  <ProfileBody>
    <DeviceIdentity VendorID="1" DeviceID="2"/>        
    <ApplicationProcess>
      <DeviceAccessPointList>
        <DeviceAccessPointItem ID="DAP" ModuleIdentNumber="1">
          <VirtualSubmoduleList>
            <VirtualSubmoduleItem ID="S" SubmoduleIdentNumber="1">
              <IOData>
                <Input>
                  <DataItem DataType="Float64"/>
                </Input>
              </IOData>
            </VirtualSubmoduleItem>
          </VirtualSubmoduleList>
        </DeviceAccessPointItem>
      </DeviceAccessPointList>
    </ApplicationProcess>
  </ProfileBody>
</ISO15745Profile>
)xml");
 
  const auto slots = dev.BuildIoSlots();
 
  ASSERT_EQ(slots.size(), 1U);
  EXPECT_EQ(slots[0].inputLength, 8U);
}
 
TEST_F(GsdmlTest, Integer16HasLengthTwo)
{
  const auto dev = Parse(R"xml(
<ISO15745Profile>
  <ProfileBody>
    <DeviceIdentity VendorID="1" DeviceID="2"/>        
    <ApplicationProcess>
      <DeviceAccessPointList>
        <DeviceAccessPointItem ID="DAP" ModuleIdentNumber="1">
          <VirtualSubmoduleList>
            <VirtualSubmoduleItem ID="S" SubmoduleIdentNumber="1">
              <IOData>
                <Input>
                  <DataItem DataType="Integer16"/>
                </Input>
              </IOData>
            </VirtualSubmoduleItem>
          </VirtualSubmoduleList>
        </DeviceAccessPointItem>
      </DeviceAccessPointList>
    </ApplicationProcess>
  </ProfileBody>
</ISO15745Profile>
)xml");
 
  const auto slots = dev.BuildIoSlots();
 
  ASSERT_EQ(slots.size(), 1U);
  EXPECT_EQ(slots[0].inputLength, 2U);
}
 
TEST_F(GsdmlTest, BooleanHasLengthOne)
{
  const auto dev = Parse(R"xml(
<ISO15745Profile>
  <ProfileBody>
    <DeviceIdentity VendorID="1" DeviceID="2"/>        
    <ApplicationProcess>
      <DeviceAccessPointList>
        <DeviceAccessPointItem ID="DAP" ModuleIdentNumber="1">
          <VirtualSubmoduleList>
            <VirtualSubmoduleItem ID="S" SubmoduleIdentNumber="1">
              <IOData>
                <Input>
                  <DataItem DataType="Boolean"/>
                </Input>
              </IOData>
            </VirtualSubmoduleItem>
          </VirtualSubmoduleList>
        </DeviceAccessPointItem>
      </DeviceAccessPointList>
    </ApplicationProcess>
  </ProfileBody>
</ISO15745Profile>
)xml");
 
  const auto slots = dev.BuildIoSlots();
 
  ASSERT_EQ(slots.size(), 1U);
  EXPECT_EQ(slots[0].inputLength, 1U);
}
 
TEST_F(GsdmlTest, OctetStringUsesExplicitLength)
{
  const auto dev = Parse(R"xml(
<ISO15745Profile>
  <ProfileBody>
    <DeviceIdentity VendorID="1" DeviceID="2"/>        
    <ApplicationProcess>
      <DeviceAccessPointList>
        <DeviceAccessPointItem ID="DAP" ModuleIdentNumber="1">
          <VirtualSubmoduleList>
            <VirtualSubmoduleItem ID="S" SubmoduleIdentNumber="1">
              <IOData>
                <Input>
                  <DataItem DataType="OctetString" Length="10"/>
                </Input>
              </IOData>
            </VirtualSubmoduleItem>
          </VirtualSubmoduleList>
        </DeviceAccessPointItem>
      </DeviceAccessPointList>
    </ApplicationProcess>
  </ProfileBody>
</ISO15745Profile>
)xml");
 
  const auto slots = dev.BuildIoSlots();
 
  ASSERT_EQ(slots.size(), 1U);
  EXPECT_EQ(slots[0].inputLength, 10U);
}
 
TEST_F(GsdmlTest, VisibleStringUsesExplicitLength)
{
  const auto dev = Parse(R"xml(
<ISO15745Profile>
  <ProfileBody>
    <DeviceIdentity VendorID="1" DeviceID="2"/>        
    <ApplicationProcess>
      <DeviceAccessPointList>
        <DeviceAccessPointItem ID="DAP" ModuleIdentNumber="1">
          <VirtualSubmoduleList>
            <VirtualSubmoduleItem ID="S" SubmoduleIdentNumber="1">
              <IOData>
                <Output>
                  <DataItem DataType="VisibleString" Length="32"/>
                </Output>
              </IOData>
            </VirtualSubmoduleItem>
          </VirtualSubmoduleList>
        </DeviceAccessPointItem>
      </DeviceAccessPointList>
    </ApplicationProcess>
  </ProfileBody>
</ISO15745Profile>
)xml");
 
  const auto slots = dev.BuildIoSlots();
 
  ASSERT_EQ(slots.size(), 1U);
  EXPECT_EQ(slots[0].outputLength, 32U);
}
 
TEST_F(GsdmlTest, MultipleDataItemsAreAccumulated)
{
  const auto dev = Parse(R"xml(
<ISO15745Profile>
  <ProfileBody>
    <DeviceIdentity VendorID="1" DeviceID="2"/>        
    <ApplicationProcess>
      <DeviceAccessPointList>
        <DeviceAccessPointItem ID="DAP" ModuleIdentNumber="1">
          <VirtualSubmoduleList>
            <VirtualSubmoduleItem ID="S" SubmoduleIdentNumber="1">
              <IOData>
                <Input>
                  <DataItem DataType="Unsigned16"/>
                  <DataItem DataType="Unsigned8"/>
                  <DataItem DataType="OctetString" Length="5"/>
                </Input>
              </IOData>
            </VirtualSubmoduleItem>
          </VirtualSubmoduleList>
        </DeviceAccessPointItem>
      </DeviceAccessPointList>
    </ApplicationProcess>
  </ProfileBody>
</ISO15745Profile>
)xml");
 
  const auto slots = dev.BuildIoSlots();
 
  ASSERT_EQ(slots.size(), 1U);
  EXPECT_EQ(slots[0].inputLength, 8U);
}
 
TEST_F(GsdmlTest, MissingIoDataProducesZeroLength)
{
  const auto dev = Parse(R"xml(
<ISO15745Profile>
  <ProfileBody>
    <DeviceIdentity VendorID="1" DeviceID="2"/>        
    <ApplicationProcess>
      <DeviceAccessPointList>
        <DeviceAccessPointItem ID="DAP" ModuleIdentNumber="1">
          <VirtualSubmoduleList>
            <VirtualSubmoduleItem ID="S" SubmoduleIdentNumber="1"/>
          </VirtualSubmoduleList>
        </DeviceAccessPointItem>
      </DeviceAccessPointList>
    </ApplicationProcess>
  </ProfileBody>
</ISO15745Profile>
)xml");
 
  const auto slots = dev.BuildIoSlots();
 
  ASSERT_EQ(slots.size(), 1U);
  EXPECT_EQ(slots[0].inputLength, 0U);
  EXPECT_EQ(slots[0].outputLength, 0U);
}
 
TEST_F(GsdmlTest, MissingInputDirectionProducesZeroInputLength)
{
  const auto dev = Parse(R"xml(
<ISO15745Profile>
  <ProfileBody>
    <DeviceIdentity VendorID="1" DeviceID="2"/>        
    <ApplicationProcess>
      <DeviceAccessPointList>
        <DeviceAccessPointItem ID="DAP" ModuleIdentNumber="1">
          <VirtualSubmoduleList>
            <VirtualSubmoduleItem ID="S" SubmoduleIdentNumber="1">
              <IOData>
                <Output>
                  <DataItem DataType="Unsigned16"/>
                </Output>
              </IOData>
            </VirtualSubmoduleItem>
          </VirtualSubmoduleList>
        </DeviceAccessPointItem>
      </DeviceAccessPointList>
    </ApplicationProcess>
  </ProfileBody>
</ISO15745Profile>
)xml");
 
  const auto slots = dev.BuildIoSlots();
 
  ASSERT_EQ(slots.size(), 1U);
  EXPECT_EQ(slots[0].inputLength, 0U);
  EXPECT_EQ(slots[0].outputLength, 2U);
}
 
TEST_F(GsdmlTest, EmptyInputProducesZeroLength)
{
  const auto dev = Parse(R"xml(
<ISO15745Profile>
  <ProfileBody>
    <DeviceIdentity VendorID="1" DeviceID="2"/>        
    <ApplicationProcess>
      <DeviceAccessPointList>
        <DeviceAccessPointItem ID="DAP" ModuleIdentNumber="1">
          <VirtualSubmoduleList>
            <VirtualSubmoduleItem ID="S" SubmoduleIdentNumber="1">
              <IOData>
                <Input/>
              </IOData>
            </VirtualSubmoduleItem>
          </VirtualSubmoduleList>
        </DeviceAccessPointItem>
      </DeviceAccessPointList>
    </ApplicationProcess>
  </ProfileBody>
</ISO15745Profile>
)xml");
 
  const auto slots = dev.BuildIoSlots();
 
  ASSERT_EQ(slots.size(), 1U);
  EXPECT_EQ(slots[0].inputLength, 0U);
}
 
// =============================================================================
// Device identity and module parsing
// =============================================================================
 
TEST_F(GsdmlTest, ParsesVendorAndDeviceId)
{
  const auto dev = Parse(MINIMAL_GSDML);
 
  EXPECT_EQ(dev.vendorId, 0x002AU);
  EXPECT_EQ(dev.deviceId, 0x0003U);
}
 
TEST_F(GsdmlTest, MissingVendorNameProducesEmptyString)
{
  const auto dev = Parse(MINIMAL_GSDML);
 
  EXPECT_TRUE(dev.vendorName.empty());
}
 
TEST_F(GsdmlTest, ParsesDeviceName)
{
  const auto dev = Parse(MINIMAL_GSDML);
 
  EXPECT_EQ(dev.deviceName, "Test Device");
}
 
TEST_F(GsdmlTest, ParsesDapModuleIdent)
{
  const auto dev = Parse(MINIMAL_GSDML);
 
  EXPECT_EQ(dev.dapModuleIdentNumber, 0x00000001U);
}
 
TEST_F(GsdmlTest, ParsesDapSubmoduleIdent)
{
  const auto dev = Parse(MINIMAL_GSDML);
 
  EXPECT_EQ(dev.dapSubmoduleIdentNumber, 0x00000001U);
}
 
TEST_F(GsdmlTest, ParsesDapVirtualSubmodule)
{
  const auto dev = Parse(MINIMAL_GSDML);
 
  ASSERT_NE(dev.FindModule("DAP_1"), nullptr);
 
  const auto* module = dev.FindModule("DAP_1");
 
  ASSERT_NE(module, nullptr);
  ASSERT_EQ(module->submodules.size(), 1U);
 
  const auto& submodule = module->submodules.at("DAP_Sub");
 
  EXPECT_EQ(submodule.id, "DAP_Sub");
  EXPECT_EQ(submodule.submoduleIdentNumber, 0x00000001U);
  EXPECT_EQ(submodule.inputLength, 1);
  EXPECT_EQ(submodule.outputLength, 0);
}
 
TEST_F(GsdmlTest, ParsesModules)
{
  const auto dev = Parse(MINIMAL_GSDML);
 
  EXPECT_EQ(dev.modules.size(), 3U);
  EXPECT_NE(dev.FindModule("DAP_1"), nullptr);
  EXPECT_NE(dev.FindModule("MOD_INPUT"), nullptr);
  EXPECT_NE(dev.FindModule("MOD_OUTPUT"), nullptr);
}
 
TEST_F(GsdmlTest, ParsesInputModule)
{
  const auto dev = Parse(MINIMAL_GSDML);
 
  const auto* module = dev.FindModule("MOD_INPUT");
 
  ASSERT_NE(module, nullptr);
  EXPECT_EQ(module->moduleIdentNumber, 0x00000010U);
  ASSERT_EQ(module->submodules.size(), 1U);
 
  const auto& submodule = module->submodules.at("MOD_IN_Sub");
 
  EXPECT_EQ(submodule.inputLength, 4);
  EXPECT_EQ(submodule.outputLength, 0);
}
 
TEST_F(GsdmlTest, ParsesOutputModule)
{
  const auto dev = Parse(MINIMAL_GSDML);
 
  const auto* module = dev.FindModule("MOD_OUTPUT");
 
  ASSERT_NE(module, nullptr);
  EXPECT_EQ(module->moduleIdentNumber, 0x00000020U);
  ASSERT_EQ(module->submodules.size(), 1U);
 
  const auto& submodule = module->submodules.at("MOD_OUT_Sub");
 
  EXPECT_EQ(submodule.inputLength, 0);
  EXPECT_EQ(submodule.outputLength, 2);
}
 
TEST_F(GsdmlTest, FindUnknownModuleReturnsNull)
{
  const auto dev = Parse(MINIMAL_GSDML);
 
  EXPECT_EQ(dev.FindModule("NONEXISTENT"), nullptr);
}
 
// =============================================================================
// Namespace handling
// =============================================================================
 
TEST_F(GsdmlTest, ParsesVendorIdWithNamespace)
{
  const auto dev = Parse(NAMESPACED_GSDML);
 
  EXPECT_EQ(dev.vendorId, 0x0042U);
}
 
TEST_F(GsdmlTest, ParsesDeviceIdWithNamespace)
{
  const auto dev = Parse(NAMESPACED_GSDML);
 
  EXPECT_EQ(dev.deviceId, 0x0007U);
}
 
TEST_F(GsdmlTest, ParsesDapWithNamespace)
{
  const auto dev = Parse(NAMESPACED_GSDML);
 
  EXPECT_EQ(dev.dapModuleIdentNumber, 0x00000002U);
  EXPECT_NE(dev.FindModule("DAP_NS"), nullptr);
}
 
TEST_F(GsdmlTest, ParsesDapIoWithNamespace)
{
  const auto dev = Parse(NAMESPACED_GSDML);
 
  const auto* dap = dev.FindModule("DAP_NS");
 
  ASSERT_NE(dap, nullptr);
  ASSERT_EQ(dap->submodules.size(), 1U);
 
  EXPECT_EQ(dap->submodules.at("Sub1").inputLength, 4);
}
 
TEST_F(GsdmlTest, ParsesModuleWithNamespace)
{
  const auto dev = Parse(NAMESPACED_GSDML);
 
  const auto* module = dev.FindModule("MOD_A");
 
  ASSERT_NE(module, nullptr);
  EXPECT_EQ(module->moduleIdentNumber, 0x000000AAU);
  EXPECT_EQ(module->submodules.at("MOD_A_Sub").outputLength, 4);
}
 
TEST_F(GsdmlTest, ParsesDifferentNamespaceVersion)
{
  const std::string xml = std::string(NAMESPACED_GSDML)
                              .replace(std::string(NAMESPACED_GSDML).find("GSDML/2.4"), 9, "GSDML/2.3");
 
  const auto dev = Parse(xml);
 
  EXPECT_EQ(dev.vendorId, 0x0042U);
  EXPECT_NE(dev.FindModule("DAP_NS"), nullptr);
}
 
// =============================================================================
// BuildIoSlots
// =============================================================================
 
TEST_F(GsdmlTest, BuildIoSlotsUsesFixedModules)
{
  const auto dev = Parse(MINIMAL_GSDML);
  const auto slots = dev.BuildIoSlots();
 
  EXPECT_EQ(slots.size(), 5U);
}
 
TEST_F(GsdmlTest, BuildIoSlotsPlacesDapAtSlotZero)
{
  const auto dev = Parse(MINIMAL_GSDML);
  const auto slots = dev.BuildIoSlots();
 
  const auto dapSlots = FindSlots(slots, 0);
 
  EXPECT_EQ(dapSlots.size(), 3U);
}
 
TEST_F(GsdmlTest, BuildIoSlotsPlacesDapSubmoduleAtSubslotOne)
{
  const auto dev = Parse(MINIMAL_GSDML);
  const auto slots = dev.BuildIoSlots();
 
  const auto& slot = FindSlot(slots, 0, 1);
 
  EXPECT_EQ(slot.inputLength, 1U);
  EXPECT_EQ(slot.outputLength, 0U);
  EXPECT_EQ(slot.moduleIdent, 0x00000001U);
  EXPECT_EQ(slot.submoduleIdent, 0x00000001U);
}
 
TEST_F(GsdmlTest, DISABLED_BuildIoSlotsPlacesInterfaceSubmodule)
{
  const auto dev = Parse(MINIMAL_GSDML);
  const auto slots = dev.BuildIoSlots();
 
  const auto& slot = FindSlot(slots, 0, 0x8000);
 
  EXPECT_EQ(slot.moduleIdent, 0x00000001U);
  EXPECT_EQ(slot.submoduleIdent, 0x00000100U);
  EXPECT_EQ(slot.inputLength, 0U);
  EXPECT_EQ(slot.outputLength, 0U);
}
 
TEST_F(GsdmlTest, DISABLED_BuildIoSlotsPlacesPortSubmodule)
{
  const auto dev = Parse(MINIMAL_GSDML);
  const auto slots = dev.BuildIoSlots();
 
  const auto& slot = FindSlot(slots, 0, 0x8001);
 
  EXPECT_EQ(slot.moduleIdent, 0x00000001U);
  EXPECT_EQ(slot.submoduleIdent, 0x00000200U);
}
 
TEST_F(GsdmlTest, BuildIoSlotsPlacesInputModule)
{
  const auto dev = Parse(MINIMAL_GSDML);
  const auto slots = dev.BuildIoSlots();
 
  const auto& slot = FindSlot(slots, 1, 1);
 
  EXPECT_EQ(slot.inputLength, 4U);
  EXPECT_EQ(slot.outputLength, 0U);
  EXPECT_EQ(slot.moduleIdent, 0x00000010U);
  EXPECT_EQ(slot.submoduleIdent, 0x00000001U);
}
 
TEST_F(GsdmlTest, BuildIoSlotsPlacesOutputModule)
{
  const auto dev = Parse(MINIMAL_GSDML);
  const auto slots = dev.BuildIoSlots();
 
  const auto& slot = FindSlot(slots, 2, 1);
 
  EXPECT_EQ(slot.inputLength, 0U);
  EXPECT_EQ(slot.outputLength, 2U);
  EXPECT_EQ(slot.moduleIdent, 0x00000020U);
  EXPECT_EQ(slot.submoduleIdent, 0x00000001U);
}
 
TEST_F(GsdmlTest, BuildIoSlotsSupportsExplicitAssignments)
{
  const auto dev = Parse(MINIMAL_GSDML);
 
  const std::vector<std::tuple<int, std::string, int, std::string>> assignment = {
      {3, "MOD_OUTPUT", 1, "MOD_OUT_Sub"},
      {5, "MOD_INPUT", 1, "MOD_IN_Sub"},
  };
 
  const auto slots = dev.BuildIoSlots(assignment);
 
  const auto& output = FindSlot(slots, 3, 1);
  const auto& input = FindSlot(slots, 5, 1);
 
  EXPECT_EQ(output.outputLength, 2U);
  EXPECT_EQ(input.inputLength, 4U);
}
 
TEST_F(GsdmlTest, BuildIoSlotsPreservesExplicitAssignmentOrder)
{
  const auto dev = Parse(MINIMAL_GSDML);
 
  const std::vector<std::tuple<int, std::string, int, std::string>> assignment = {
      {5, "MOD_INPUT", 1, "MOD_IN_Sub"},
      {3, "MOD_OUTPUT", 1, "MOD_OUT_Sub"},
  };
 
  const auto slots = dev.BuildIoSlots(assignment);
 
  ASSERT_EQ(slots.size(), 5U);
 
  EXPECT_EQ(slots[3].slot, 5U);
  EXPECT_EQ(slots[4].slot, 3U);
}
 
TEST_F(GsdmlTest, BuildIoSlotsRejectsUnknownModule)
{
  const auto dev = Parse(MINIMAL_GSDML);
 
  const std::vector<std::tuple<int, std::string, int, std::string>> assignment = {
      {1, "NONEXISTENT", 1, "S"},
  };
 
  EXPECT_THROW(dev.BuildIoSlots(assignment), std::invalid_argument);
}
 
TEST_F(GsdmlTest, BuildIoSlotsRejectsUnknownSubmodule)
{
  const auto dev = Parse(MINIMAL_GSDML);
 
  const std::vector<std::tuple<int, std::string, int, std::string>> assignment = {
      {1, "MOD_INPUT", 1, "NONEXISTENT"},
  };
 
  EXPECT_THROW(dev.BuildIoSlots(assignment), std::invalid_argument);
}
 
TEST_F(GsdmlTest, BuildIoSlotsRejectsDisallowedSlot)
{
  const auto dev = Parse(MINIMAL_GSDML);
 
  const std::vector<std::tuple<int, std::string, int, std::string>> assignment = {
      {9, "MOD_INPUT", 1, "MOD_IN_Sub"},
  };
 
  EXPECT_THROW(dev.BuildIoSlots(assignment), std::invalid_argument);
}
 
TEST_F(GsdmlTest, BuildIoSlotsAllowsUnrestrictedModule)
{
  const auto xml = R"xml(
<ISO15745Profile>
  <ProfileBody>
    <DeviceIdentity VendorID="1" DeviceID="2"/>        
    <ApplicationProcess>
      <DeviceAccessPointList>
        <DeviceAccessPointItem ID="DAP" ModuleIdentNumber="1"/>
      </DeviceAccessPointList>
      <ModuleList>
        <ModuleItem ID="MOD" ModuleIdentNumber="2">
          <VirtualSubmoduleList>
            <VirtualSubmoduleItem ID="SUB" SubmoduleIdentNumber="3">
              <IOData>
                <Input>
                  <DataItem DataType="Unsigned8"/>
                </Input>
              </IOData>
            </VirtualSubmoduleItem>
          </VirtualSubmoduleList>
        </ModuleItem>
      </ModuleList>
    </ApplicationProcess>
  </ProfileBody>
</ISO15745Profile>
)xml";
 
  const auto dev = Parse(xml);
 
  const std::vector<std::tuple<int, std::string, int, std::string>> assignment = {
      {99, "MOD", 1, "SUB"},
  };
 
  const auto slots = dev.BuildIoSlots(assignment);
 
  ASSERT_EQ(slots.size(), 1U);
  EXPECT_EQ(slots[0].slot, 99U);
}
 
TEST_F(GsdmlTest, BuildIoSlotsMaintainsSlotOrder)
{
  const auto dev = Parse(MINIMAL_GSDML);
  const auto slots = dev.BuildIoSlots();
 
  ASSERT_EQ(slots.size(), 5U);
 
  EXPECT_EQ(slots[0].slot, 0U);
  EXPECT_EQ(slots[1].slot, 0U);
  EXPECT_EQ(slots[2].slot, 0U);
  EXPECT_EQ(slots[3].slot, 1U);
  EXPECT_EQ(slots[4].slot, 2U);
}
 
// =============================================================================
// Edge cases
// =============================================================================
 
TEST_F(GsdmlTest, ModuleWithoutIoDataHasZeroLengths)
{
  const auto xml = R"xml(
<ISO15745Profile>
  <ProfileBody>
    <ApplicationProcess>
      <DeviceAccessPointList>
        <DeviceAccessPointItem ID="DAP" ModuleIdentNumber="1"/>
      </DeviceAccessPointList>
      <ModuleList>
        <ModuleItem ID="NO_IO" ModuleIdentNumber="0x99">
          <VirtualSubmoduleList>
            <VirtualSubmoduleItem ID="S1" SubmoduleIdentNumber="1"/>
          </VirtualSubmoduleList>
        </ModuleItem>
      </ModuleList>
    </ApplicationProcess>
  </ProfileBody>
</ISO15745Profile>
)xml";
 
  const auto dev = Parse(xml);
  const auto* module = dev.FindModule("NO_IO");
 
  ASSERT_NE(module, nullptr);
  ASSERT_EQ(module->submodules.size(), 1U);
 
  EXPECT_EQ(module->submodules.at("S1").inputLength, 0);
  EXPECT_EQ(module->submodules.at("S1").outputLength, 0);
}
 
TEST_F(GsdmlTest, ModuleWithoutVirtualSubmoduleListHasNoSubmodules)
{
  const auto xml = R"xml(
<ISO15745Profile>
  <ProfileBody>
    <DeviceIdentity VendorID="1" DeviceID="2"/>        
    <ApplicationProcess>
      <DeviceAccessPointList>
        <DeviceAccessPointItem ID="DAP" ModuleIdentNumber="1"/>
      </DeviceAccessPointList>
      <ModuleList>
        <ModuleItem ID="EMPTY" ModuleIdentNumber="0xFF"/>
      </ModuleList>
    </ApplicationProcess>
  </ProfileBody>
</ISO15745Profile>
)xml";
 
  const auto dev = Parse(xml);
  const auto* module = dev.FindModule("EMPTY");
 
  ASSERT_NE(module, nullptr);
  EXPECT_TRUE(module->submodules.empty());
}
 
TEST_F(GsdmlTest, MissingDeviceIdentityProducesZeroIds)
{
  const auto xml = R"xml(
<ISO15745Profile>
  <ProfileBody>
    <ApplicationProcess>
      <DeviceAccessPointList>
        <DeviceAccessPointItem ID="DAP" ModuleIdentNumber="1"/>
      </DeviceAccessPointList>
    </ApplicationProcess>
  </ProfileBody>
</ISO15745Profile>
)xml";
 
  const auto dev = Parse(xml);
 
  EXPECT_EQ(dev.vendorId, 0U);
  EXPECT_EQ(dev.deviceId, 0U);
}
 
TEST_F(GsdmlTest, MissingDapProducesEmptyDapInformation)
{
  const auto xml = R"xml(
<ISO15745Profile>
  <ProfileBody>
    <DeviceIdentity VendorID="1" DeviceID="2"/>
    <ApplicationProcess>
      <ModuleList/>
    </ApplicationProcess>
  </ProfileBody>
</ISO15745Profile>
)xml";
 
  const auto dev = Parse(xml);
 
  EXPECT_EQ(dev.dapModuleIdentNumber, 0U);
  EXPECT_EQ(dev.dapSubmoduleIdentNumber, 0U);
  EXPECT_TRUE(dev.systemSubmodules.empty());
}
 
TEST_F(GsdmlTest, DapWithoutUseableModulesProducesOnlyDapSlots)
{
  const auto xml = R"xml(
<ISO15745Profile>
  <ProfileBody>
    <DeviceIdentity VendorID="1" DeviceID="2"/>        
    <ApplicationProcess>
      <DeviceAccessPointList>
        <DeviceAccessPointItem ID="DAP" ModuleIdentNumber="1">
          <VirtualSubmoduleList>
            <VirtualSubmoduleItem ID="S" SubmoduleIdentNumber="1">
              <IOData>
                <Input>
                  <DataItem DataType="Unsigned8"/>
                </Input>
              </IOData>
            </VirtualSubmoduleItem>
          </VirtualSubmoduleList>
        </DeviceAccessPointItem>
      </DeviceAccessPointList>
      <ModuleList/>
    </ApplicationProcess>
  </ProfileBody>
</ISO15745Profile>
)xml";
 
  const auto dev = Parse(xml);
  const auto slots = dev.BuildIoSlots();
 
  ASSERT_EQ(slots.size(), 1U);
  EXPECT_EQ(slots[0].slot, 0U);
  EXPECT_EQ(slots[0].subslot, 1U);
  EXPECT_EQ(slots[0].inputLength, 1U);
}
 
TEST_F(GsdmlTest, MalformedXmlThrows)
{
  EXPECT_THROW(Parse("<ISO15745Profile><ProfileBody>"), std::runtime_error);
}
 
TEST_F(GsdmlTest, EmptyXmlThrows)
{
  EXPECT_THROW(Parse(""), std::runtime_error);
}
 
TEST_F(GsdmlTest, WhitespaceOnlyXmlThrows)
{
  EXPECT_THROW(Parse("   \n\t  "), std::runtime_error);
}
 
// =============================================================================
// ParseGsdml file tests
// =============================================================================
 
TEST_F(GsdmlTest, ParseGsdmlReadsFile)
{
  const auto path = std::filesystem::temp_directory_path() / "gsdml_test.xml";
 
  {
    std::ofstream file(path);
    ASSERT_TRUE(file.is_open());
    file << MINIMAL_GSDML;
  }
 
  const auto dev = ParseGsdml(path.string());
 
  EXPECT_EQ(dev.vendorId, 0x002AU);
  EXPECT_EQ(dev.deviceId, 0x0003U);
  EXPECT_EQ(dev.modules.size(), 3U);
 
  std::filesystem::remove(path);
}
 
TEST_F(GsdmlTest, ParseGsdmlThrowsForMissingFile)
{
  const auto path = std::filesystem::temp_directory_path() / "definitely_missing_gsdml_file.xml";
 
  EXPECT_THROW(ParseGsdml(path.string()), std::runtime_error);
}
 
// =============================================================================
// Text resolution
// =============================================================================
 
TEST_F(GsdmlTest, ResolvesExternalTextId)
{
  const auto xml = R"xml(
<ISO15745Profile>
  <ProfileBody>
    <DeviceIdentity VendorID="1" DeviceID="2">
      <Name TextId="T_VENDOR"/>
    </DeviceIdentity>
    <ApplicationProcess>
      <ExternalTextList>
        <PrimaryLanguage>
          <Text TextId="T_VENDOR" Value="Vendor Name"/>
        </PrimaryLanguage>
      </ExternalTextList>
      <DeviceAccessPointList>
        <DeviceAccessPointItem ID="DAP" ModuleIdentNumber="1"/>
      </DeviceAccessPointList>
    </ApplicationProcess>
  </ProfileBody>
</ISO15745Profile>
)xml";
 
  const auto dev = Parse(xml);
 
  EXPECT_EQ(dev.vendorName, "Vendor Name");
}
 
TEST_F(GsdmlTest, ResolvesLiteralNameValue)
{
  const auto xml = R"xml(
<ISO15745Profile>
  <ProfileBody>
    <DeviceIdentity VendorID="1" DeviceID="2">
      <Name Value="Literal Vendor"/>
    </DeviceIdentity>
    <ApplicationProcess>
      <DeviceAccessPointList>
        <DeviceAccessPointItem ID="DAP" ModuleIdentNumber="1"/>
      </DeviceAccessPointList>
    </ApplicationProcess>
  </ProfileBody>
</ISO15745Profile>
)xml";
 
  const auto dev = Parse(xml);
 
  EXPECT_EQ(dev.vendorName, "Literal Vendor");
}
 
// =============================================================================
// Numeric parsing
// =============================================================================
 
TEST_F(GsdmlTest, ParsesHexadecimalIdentifiers)
{
  const auto dev = Parse(MINIMAL_GSDML);
 
  EXPECT_EQ(dev.vendorId, 42U);
  EXPECT_EQ(dev.deviceId, 3U);
  EXPECT_EQ(dev.dapModuleIdentNumber, 1U);
}
 
TEST_F(GsdmlTest, ParsesDecimalIdentifiers)
{
  const auto dev = Parse(DATA_TYPES_GSDML);
 
  EXPECT_EQ(dev.vendorId, 42U);
  EXPECT_EQ(dev.deviceId, 7U);
}
 
TEST_F(GsdmlTest, InvalidNumericAttributeFallsBackToZero)
{
  const auto xml = R"xml(
<ISO15745Profile>
  <ProfileBody>
    <DeviceIdentity VendorID="not-a-number" DeviceID="7"/>
    <ApplicationProcess>
      <DeviceAccessPointList>
        <DeviceAccessPointItem ID="DAP" ModuleIdentNumber="invalid"/>
      </DeviceAccessPointList>
    </ApplicationProcess>
  </ProfileBody>
</ISO15745Profile>
)xml";
 
  const auto dev = Parse(xml);
 
  EXPECT_EQ(dev.vendorId, 0U);
  EXPECT_EQ(dev.deviceId, 7U);
  EXPECT_EQ(dev.dapModuleIdentNumber, 0U);
}
 
// =============================================================================
// DataItem metadata
// =============================================================================
 
TEST_F(GsdmlTest, ParsesDataItemMetadata)
{
  const auto xml = R"xml(
<ISO15745Profile>
  <ProfileBody>
  <DeviceIdentity VendorID="1" DeviceID="2"/>            
    <ApplicationProcess>
      <DeviceAccessPointList>
        <DeviceAccessPointItem ID="DAP" ModuleIdentNumber="1">
          <VirtualSubmoduleList>
            <VirtualSubmoduleItem ID="S" SubmoduleIdentNumber="1">
              <IOData>
                <Input>
                  <DataItem DataType="Unsigned16" TextId="VALUE"/>
                </Input>
              </IOData>
            </VirtualSubmoduleItem>
          </VirtualSubmoduleList>
        </DeviceAccessPointItem>
      </DeviceAccessPointList>
    </ApplicationProcess>
  </ProfileBody>
</ISO15745Profile>
)xml";
 
  const auto dev = Parse(xml);
  const auto* dap = dev.FindModule("DAP");
 
  ASSERT_NE(dap, nullptr);
 
  const auto& submodule = dap->submodules.at("S");
 
  ASSERT_EQ(submodule.inputItems.size(), 1U);
  EXPECT_EQ(submodule.inputItems[0].dataType, "Unsigned16");
  EXPECT_EQ(submodule.inputItems[0].textId, "VALUE");
  EXPECT_EQ(submodule.inputItems[0].length, 2);
}
 
TEST_F(GsdmlTest, SeparatesInputAndOutputDataItems)
{
  const auto xml = R"xml(
<ISO15745Profile>
  <ProfileBody>
    <DeviceIdentity VendorID="1" DeviceID="2"/>        
    <ApplicationProcess>
      <DeviceAccessPointList>
        <DeviceAccessPointItem ID="DAP" ModuleIdentNumber="1">
          <VirtualSubmoduleList>
            <VirtualSubmoduleItem ID="S" SubmoduleIdentNumber="1">
              <IOData>
                <Input>
                  <DataItem DataType="Unsigned8"/>
                </Input>
                <Output>
                  <DataItem DataType="Unsigned32"/>
                </Output>
              </IOData>
            </VirtualSubmoduleItem>
          </VirtualSubmoduleList>
        </DeviceAccessPointItem>
      </DeviceAccessPointList>
    </ApplicationProcess>
  </ProfileBody>
</ISO15745Profile>
)xml";
 
  const auto dev = Parse(xml);
  const auto* dap = dev.FindModule("DAP");
 
  ASSERT_NE(dap, nullptr);
 
  const auto& submodule = dap->submodules.at("S");
 
  ASSERT_EQ(submodule.inputItems.size(), 1U);
  ASSERT_EQ(submodule.outputItems.size(), 1U);
 
  EXPECT_EQ(submodule.inputItems[0].dataType, "Unsigned8");
  EXPECT_EQ(submodule.outputItems[0].dataType, "Unsigned32");
  EXPECT_EQ(submodule.inputLength, 1);
  EXPECT_EQ(submodule.outputLength, 4);
}
 
} // namespace
 
} // namespace profinet::gsdml