added test cases for designatedproductclassification, changed paramet…

…er order (breaking change) #335
stephanstapel · Aug 29, 2024 · f1db682 · f1db682
1 parent 6bc4313
commit f1db682
Show file tree

Hide file tree

Showing 6 changed files with 148 additions and 20 deletions.
diff --git a/ZUGFeRD-Test/ZUGFeRD22Tests.cs b/ZUGFeRD-Test/ZUGFeRD22Tests.cs
@@ -2035,5 +2035,111 @@ public void ShouldLoadCiiWithoutQdtNamespace()
  Assert.AreEqual(desc.TradeLineItems.Count, 2);
  Assert.AreEqual(desc.LineTotalAmount, 314.86m);
  } // !ShouldLoadCIIWithoutQdtNamespace()
- }
+
+
+ [TestMethod]
+ public void TestDesignatedProductClassificationWithFullClassification()
+ {
+ InvoiceDescriptor desc = this.InvoiceProvider.CreateInvoice();
+ desc.TradeLineItems.First().AddDesignatedProductClassification( 
+ "Test Value",
+ DesignatedProductClassificationClassCodes.HS,
+ "List ID Value",
+ "List Version ID Value");
+
+ MemoryStream ms = new MemoryStream();
+
+ desc.Save(ms, ZUGFeRDVersion.Version22, Profile.XRechnung);
+
+ // string comparison
+ ms.Seek(0, SeekOrigin.Begin);
+ StreamReader reader = new StreamReader(ms);
+ string content = reader.ReadToEnd();
+ Assert.IsTrue(content.Contains("<ram:DesignatedProductClassification>"));
+ Assert.IsTrue(content.Contains("<ram:ClassCode listID=\"List ID Value\" listVersionID=\"List Version ID Value\">HS</ram:ClassCode>"));
+ Assert.IsTrue(content.Contains("<ram:ClassName>Test Value</ram:ClassName>"));
+
+ // structure comparison
+ ms.Seek(0, SeekOrigin.Begin);
+ File.WriteAllBytes("e:\\output.xml", ms.ToArray());
+
+ ms.Seek(0, SeekOrigin.Begin);
+ InvoiceDescriptor loadedInvoice = InvoiceDescriptor.Load(ms);
+
+ Assert.AreEqual(DesignatedProductClassificationClassCodes.HS, desc.TradeLineItems.First().GetDesignatedProductClassifications().First().ClassCode);
+ Assert.AreEqual("Test Value", desc.TradeLineItems.First().GetDesignatedProductClassifications().First().ClassName);
+ Assert.AreEqual("List ID Value", desc.TradeLineItems.First().GetDesignatedProductClassifications().First().ListID);
+ Assert.AreEqual("List Version ID Value", desc.TradeLineItems.First().GetDesignatedProductClassifications().First().ListVersionID);
+ } // !TestDesignatedProductClassificationWithFullClassification()
+
+
+ [TestMethod]
+ public void TestDesignatedProductClassificationWithEmptyVersionId()
+ {
+ // test with empty version id value
+ InvoiceDescriptor desc = this.InvoiceProvider.CreateInvoice();
+ desc.TradeLineItems.First().AddDesignatedProductClassification(
+ "Test Value",
+ DesignatedProductClassificationClassCodes.HS,
+ "List ID Value"
+ );
+
+ MemoryStream ms = new MemoryStream();
+
+ desc.Save(ms, ZUGFeRDVersion.Version22, Profile.XRechnung);
+
+ ms.Seek(0, SeekOrigin.Begin);
+ InvoiceDescriptor loadedInvoice = InvoiceDescriptor.Load(ms);
+
+ Assert.AreEqual(DesignatedProductClassificationClassCodes.HS, desc.TradeLineItems.First().GetDesignatedProductClassifications().First().ClassCode);
+ Assert.AreEqual("Test Value", desc.TradeLineItems.First().GetDesignatedProductClassifications().First().ClassName);
+ Assert.AreEqual("List ID Value", desc.TradeLineItems.First().GetDesignatedProductClassifications().First().ListID);
+ Assert.IsNull(desc.TradeLineItems.First().GetDesignatedProductClassifications().First().ListVersionID);
+ } // !TestDesignatedProductClassificationWithEmptyVersionId()
+
+
+
+ [TestMethod]
+ public void TestDesignatedProductClassificationWithEmptyListIdAndVersionId()
+ {
+ // test with empty version id value
+ InvoiceDescriptor desc = this.InvoiceProvider.CreateInvoice();
+ desc.TradeLineItems.First().AddDesignatedProductClassification( 
+ "Test Value",
+ DesignatedProductClassificationClassCodes.HS);
+
+ MemoryStream ms = new MemoryStream();
+
+ desc.Save(ms, ZUGFeRDVersion.Version22, Profile.XRechnung);
+
+ ms.Seek(0, SeekOrigin.Begin);
+ InvoiceDescriptor loadedInvoice = InvoiceDescriptor.Load(ms);
+
+ Assert.AreEqual(DesignatedProductClassificationClassCodes.HS, desc.TradeLineItems.First().GetDesignatedProductClassifications().First().ClassCode);
+ Assert.AreEqual("Test Value", desc.TradeLineItems.First().GetDesignatedProductClassifications().First().ClassName);
+ Assert.IsNull(desc.TradeLineItems.First().GetDesignatedProductClassifications().First().ListID);
+ Assert.IsNull(desc.TradeLineItems.First().GetDesignatedProductClassifications().First().ListVersionID);
+ } // !TestDesignatedProductClassificationWithEmptyListIdAndVersionId()
+
+
+ [TestMethod]
+ public void TestDesignatedProductClassificationWithoutClassCode()
+ {
+ // test with empty version id value
+ InvoiceDescriptor desc = this.InvoiceProvider.CreateInvoice();
+ desc.TradeLineItems.First().AddDesignatedProductClassification("Test Value");
+
+ MemoryStream ms = new MemoryStream();
+
+ desc.Save(ms, ZUGFeRDVersion.Version22, Profile.XRechnung);
+
+ ms.Seek(0, SeekOrigin.Begin);
+ InvoiceDescriptor loadedInvoice = InvoiceDescriptor.Load(ms);
+
+ Assert.AreEqual(default(DesignatedProductClassificationClassCodes), desc.TradeLineItems.First().GetDesignatedProductClassifications().First().ClassCode);
+ Assert.AreEqual("Test Value", desc.TradeLineItems.First().GetDesignatedProductClassifications().First().ClassName);
+ Assert.IsNull(desc.TradeLineItems.First().GetDesignatedProductClassifications().First().ListID);
+ Assert.IsNull(desc.TradeLineItems.First().GetDesignatedProductClassifications().First().ListVersionID);
+ } // !TestDesignatedProductClassificationWithoutClassCode()
+ }
 }
diff --git a/ZUGFeRD/DesignatedProductClassificationClassCodes.cs b/ZUGFeRD/DesignatedProductClassificationClassCodes.cs
@@ -22,11 +22,33 @@
 
 namespace s2industries.ZUGFeRD
 {
- public enum DesignatedProductClassificationClassCodes
+ /// <summary>
+ /// A code for the classification of an item according to type or kind or nature.
+ /// 
+ /// Classification codes are used for the aggregation of similar products, which might be useful for various
+ /// purposes,
+ /// for instance like public procurement, in accordance with the Common Vocabulary for Public Procurement
+ /// [CPV]), e-Commerce(UNSPSC) etc.
+ /// 
+ /// Source: UNTDID 7143
+ /// Business rule: BR-65
+ /// </summary>
+ public enum DesignatedProductClassificationClassCodes
  {
- HS,
- Unknown
- }
+ Unknown = 0,
+
+ /// <summary>
+ /// Product version number
+ /// Number assigned by manufacturer or seller to identify the release of a product.
+ /// </summary>
+ AA,
+
+ /// <summary>
+ /// Harmonised system
+ /// The item number is part of, or is generated in the context of the Harmonised Commodity Description and Coding System (Harmonised System), as developed and maintained by the World Customs Organization (WCO).
+ /// </summary>
+ HS
+ }
 
  internal static class DesignatedProductClassificationClassCodesExtensions
  {

diff --git a/ZUGFeRD/InvoiceDescriptor22CIIReader.cs b/ZUGFeRD/InvoiceDescriptor22CIIReader.cs
@@ -615,7 +615,7 @@ private static TradeLineItem _parseTradeLineItem(XmlNode tradeLineItem, XmlNames
  string listID = XmlUtils.NodeAsString(designatedProductClassificationNode, ".//ram:ClassCode/@listID", nsmgr);
  string listVersionID = XmlUtils.NodeAsString(designatedProductClassificationNode, ".//ram:ClassCode/@listVersionID", nsmgr);
 
- item.AddDesignatedProductClassification(classCode, className, listID, listVersionID);
+ item.AddDesignatedProductClassification(className, classCode, listID, listVersionID);
  } // !foreach(designatedProductClassificationNode))
 
  return item;

diff --git a/ZUGFeRD/InvoiceDescriptor22CIIWriter.cs b/ZUGFeRD/InvoiceDescriptor22CIIWriter.cs
@@ -175,12 +175,11 @@ public override void Save(InvoiceDescriptor descriptor, Stream stream, ZUGFeRDFo
  {
  foreach(var designatedProductClassification in tradeLineItem.GetDesignatedProductClassifications())
  {
- Writer.WriteStartElement("ram:DesignatedProductClassification");
- Writer.WriteOptionalElementString("ram:ClassName", designatedProductClassification.ClassName);
+ Writer.WriteStartElement("ram:DesignatedProductClassification"); 
 
  if (designatedProductClassification.ClassCode.HasValue)
  {
- Writer.WriteStartElement("ram::ClassCode");
+ Writer.WriteStartElement("ram:ClassCode");
  if (!String.IsNullOrWhiteSpace(designatedProductClassification.ListID))
  {
  Writer.WriteAttributeString("listID", designatedProductClassification.ListID);
@@ -189,7 +188,8 @@ public override void Save(InvoiceDescriptor descriptor, Stream stream, ZUGFeRDFo
  Writer.WriteValue(designatedProductClassification.ClassCode.Value.ToString());
  Writer.WriteEndElement(); // !ram::ClassCode
  }
- Writer.WriteEndElement(); // !ram:DesignatedProductClassification
+ Writer.WriteOptionalElementString("ram:ClassName", designatedProductClassification.ClassName);
+ Writer.WriteEndElement(); // !ram:DesignatedProductClassification
  }
  }
 

diff --git a/ZUGFeRD/InvoiceDescriptor22UblReader.cs b/ZUGFeRD/InvoiceDescriptor22UblReader.cs
@@ -476,8 +476,8 @@ private static TradeLineItem _parseTradeLineItem(XmlNode tradeLineItem, XmlNames
  {
  DesignatedProductClassificationClassCodes code = default(DesignatedProductClassificationClassCodes).FromString(commodityClassification.InnerText);
  item.AddDesignatedProductClassification(
- code,
- "", // no name in Peppol Billing!
+ "", // no name in Peppol Billing!
+ code, 
  XmlUtils.NodeAsString(commodityClassification, "./@listID", nsmgr),
  XmlUtils.NodeAsString(commodityClassification, "./@istVersionID", nsmgr));
  }

diff --git a/ZUGFeRD/TradeLineItem.cs b/ZUGFeRD/TradeLineItem.cs
@@ -388,14 +388,14 @@ public void AddReceivableSpecifiedTradeAccountingAccount(string AccountID, Accou
  }
 
 
- /// <summary>
- /// Adds a product classification
- /// </summary>
- /// <param name="classCode">Identifier of the item classification</param>
- /// <param name="className">Classification name. If you leave className empty, it will be omitted in the output</param>
- /// <param name="listID">Product classification name (optional)</param>
- /// <param name="listVersionID">Version of product classification (optional)</param>
- public void AddDesignatedProductClassification(DesignatedProductClassificationClassCodes classCode, string className, string listID = null, string listVersionID = null)
+ /// <summary>
+ /// Adds a product classification
+ /// </summary>
+ /// <param name="className">Classification name. If you leave className empty, it will be omitted in the output</param>
+ /// <param name="classCode">Identifier of the item classification (optional)</param>
+ /// <param name="listID">Product classification name (optional)</param>
+ /// <param name="listVersionID">Version of product classification (optional)</param> 
+ public void AddDesignatedProductClassification(string className, DesignatedProductClassificationClassCodes classCode = default(DesignatedProductClassificationClassCodes), string listID = null, string listVersionID = null)
  {
  this.DesignedProductClassifications.Add(new DesignatedProductClassification()
  {