mono/mcs/class/System.Windows.Forms/Test/System.Resources/ResXDataNodeWriteBehavior.cs

//
// ResXDataNodeWriteBehavior.cs : Tests how ResXDataNode's are written to
// resx files.
// 
// Author:
//	Gary Barnett ([email protected])
// 
// Copyright (C) Gary Barnett (2012)
//
// Permission is hereby granted, free of charge, to any person obtaining
// a copy of this software and associated documentation files (the
// "Software"), to deal in the Software without restriction, including
// without limitation the rights to use, copy, modify, merge, publish,
// distribute, sublicense, and/or sell copies of the Software, and to
// permit persons to whom the Software is furnished to do so, subject to
// the following conditions:
// 
// The above copyright notice and this permission notice shall be
// included in all copies or substantial portions of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
// LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

using System;
using System.IO;
using System.Reflection;
using System.Resources;
using System.Collections;
using NUnit.Framework;
using System.Text;
using System.ComponentModel.Design;

namespace MonoTests.System.Resources {
	[TestFixture]
	public class ResXDataNodeWriteBehavior : ResourcesTestHelper {
		
		[Test]
		public void TypeConverterObjectNotLoaded ()
		{
			ResXDataNode node = GetNodeFromResXReader (convertableResXWithoutAssemblyName);
			Assert.IsNotNull (node, "#A1");
			// would cause error if object loaded
			GetNodeFromResXReader (node);
		}

		[Test]
		public void SerializedObjectNotLoaded ()
		{
			ResXDataNode node = GetNodeFromResXReader (serializedResXCorruped);
			Assert.IsNotNull (node, "#A1");
			// would cause error if object loaded
			GetNodeFromResXReader (node);
		}

		[Test, ExpectedException (typeof (ArgumentException))]
		public void FileRefIsLoaded ()
		{
			// .NET doesnt instantiate the encoding until the write
			ResXDataNode node = GetNodeFromResXReader (fileRefResXCorrupted);
			Assert.IsNotNull (node, "#A1");
			// would cause error if object loaded
			GetNodeFromResXReader (node);
		}

		[Test]
		public void ResXNullRef_WriteBack ()
		{
			ResXDataNode node = new ResXDataNode ("NullRef", (object) null);
			node.Comment = "acomment";
			ResXDataNode returnedNode = GetNodeFromResXReader (node);
			Assert.IsNotNull (returnedNode, "#A1");
			Assert.IsNull (returnedNode.GetValue ((AssemblyName []) null), "#A2");
			Assert.AreEqual ("acomment", returnedNode.Comment,"#A3");
			ResXDataNode finalNode = GetNodeFromResXReader (returnedNode);
			Assert.IsNotNull (finalNode, "#A4");
			Assert.IsNull (finalNode.GetValue ((AssemblyName []) null), "#A5");
			Assert.AreEqual ("acomment", finalNode.Comment,"#A6");
		}

		[Test]
		public void InvalidMimeType_WriteBack ()
		{
			//FIXME: should check the ResX output to ensure mime type / value info still there
			ResXDataNode node = GetNodeFromResXReader (serializedResXInvalidMimeType);
			Assert.IsNotNull (node, "#A1");
			ResXDataNode returnedNode = GetNodeFromResXReader (node);
			Assert.IsNotNull (returnedNode, "#A2");
			object obj = returnedNode.GetValue ((AssemblyName []) null);
			Assert.IsNull (obj, "#A3");
		}

		[Test]
		public void InvalidMimeTypeAndType_WriteBack ()
		{
			ResXDataNode node = GetNodeFromResXReader (typeconResXInvalidMimeTypeAndType);
			Assert.IsNotNull (node, "#A1");
			ResXDataNode returnedNode = GetNodeFromResXReader (node);
			Assert.IsNotNull (returnedNode, "#A2");
			string type = returnedNode.GetValueTypeName ((AssemblyName []) null);
			Assert.AreEqual ("A.type", type, "#A3");
		}

		[Test]
		public void BinTypeConverter_WriteBack ()
		{
			MyBinType mb = new MyBinType ("contents");
			ResXDataNode node = new ResXDataNode ("aname", mb);
			node.Comment = "acomment";
			ResXDataNode returnedNode = GetNodeFromResXReader (node);
			Assert.IsNotNull (returnedNode, "#A1");
			MyBinType returnedMB = (MyBinType) returnedNode.GetValue ((AssemblyName []) null);
			Assert.AreEqual ("contents", returnedMB.Value, "#A2");
			Assert.AreEqual ("acomment", returnedNode.Comment, "#A3");
			ResXDataNode finalNode = GetNodeFromResXReader (returnedNode);
			Assert.IsNotNull (finalNode, "#A4");
			MyBinType finalMB = (MyBinType) finalNode.GetValue ((AssemblyName []) null);
			Assert.AreEqual ("contents", finalMB.Value, "#A5");
			Assert.AreEqual ("acomment", finalNode.Comment, "#A6");
		}

		[Test]
		public void FileRefWithEncoding_WriteBack ()
		{
			ResXFileRef fileRef = new ResXFileRef ("afilename", "A.Type.Name", Encoding.UTF7);
			ResXDataNode node = new ResXDataNode ("aname", fileRef);
			node.Comment = "acomment";
			ResXDataNode returnedNode = GetNodeFromResXReader (node);
			Assert.IsNotNull (returnedNode, "#A1");
			Assert.AreEqual ("afilename", returnedNode.FileRef.FileName, "#A2");
			Assert.AreEqual ("A.Type.Name", returnedNode.FileRef.TypeName, "#A3");
			Assert.AreEqual ("acomment", returnedNode.Comment, "#A4");
			Assert.IsInstanceOfType (Encoding.UTF7.GetType (), returnedNode.FileRef.TextFileEncoding, "#A5");
			ResXDataNode finalNode = GetNodeFromResXReader (returnedNode);
			Assert.IsNotNull (finalNode, "#A6");
			Assert.AreEqual ("afilename", finalNode.FileRef.FileName, "#A7");
			Assert.AreEqual ("A.Type.Name", finalNode.FileRef.TypeName, "#A8");
			Assert.AreEqual ("acomment", finalNode.Comment, "#A9");
			Assert.IsInstanceOfType (Encoding.UTF7.GetType (), finalNode.FileRef.TextFileEncoding, "#A10");
		}

		[Test]
		public void ByteArray_WriteBack ()
		{
			byte [] testBytes = new byte [] { 1,2,3,4,5,6,7,8,9,10 };
			ResXDataNode node = new ResXDataNode ("aname", testBytes);
			node.Comment = "acomment";
			ResXDataNode returnedNode = GetNodeFromResXReader (node);
			Assert.IsNotNull (returnedNode, "#A1");
			Assert.AreEqual (testBytes, returnedNode.GetValue ((AssemblyName []) null), "#A2");
			Assert.AreEqual ("acomment", returnedNode.Comment, "#A3");
			ResXDataNode finalNode = GetNodeFromResXReader (returnedNode);
			Assert.IsNotNull (finalNode,"#A4");
			Assert.AreEqual (testBytes, finalNode.GetValue ((AssemblyName []) null), "#A5");
			Assert.AreEqual ("acomment", finalNode.Comment, "#A6");
		}

		[Test]
		public void BasePathSetOnResXReaderAffectsFileRef_WriteBack ()
		{
			ResXDataNode returnedNode;
			StringWriter sw = new StringWriter ();
			sw.Write (fileRefResX);

			StringReader sr = new StringReader (sw.GetStringBuilder ().ToString ());

			using (ResXResourceReader reader = new ResXResourceReader (sr)) {
				reader.UseResXDataNodes = true;
				reader.BasePath = "basePath";
				IDictionaryEnumerator enumerator = reader.GetEnumerator ();
				enumerator.MoveNext ();

				ResXDataNode node = ((DictionaryEntry) enumerator.Current).Value as ResXDataNode;
				Assert.IsNotNull (node, "#A1");
				Assert.AreEqual (Path.Combine ("basePath","file.name"), node.FileRef.FileName, "#A2");
				returnedNode = GetNodeFromResXReader (node);
			}

			Assert.AreEqual (Path.Combine ("basePath","file.name"), returnedNode.FileRef.FileName, "#A3");
		}

		[Test]
		public void Serialized_WriteBack ()
		{

			ResXDataNode node, returnedNode, finalNode;
			node = GetNodeEmdeddedSerializable ();
			node.Comment = "acomment";
			returnedNode = GetNodeFromResXReader (node);
			Assert.IsNotNull (returnedNode, "#A1");
			Assert.AreEqual ("acomment", returnedNode.Comment, "#A2");
			object returnedObj = returnedNode.GetValue ((ITypeResolutionService) null);
			Assert.IsInstanceOfType (typeof (serializable), returnedObj, "#A3");
			serializable returnedSer = (serializable) returnedObj;
			Assert.AreEqual ("testName", returnedSer.name, "A4");

			finalNode = GetNodeFromResXReader (returnedNode);
			Assert.IsNotNull (finalNode, "#A5");
			Assert.AreEqual ("acomment", finalNode.Comment, "#A6");
			object finalObj = finalNode.GetValue ((ITypeResolutionService) null);
			Assert.IsInstanceOfType (typeof (serializable), finalObj, "#A7");
			serializable finalSer = (serializable) finalObj;
			Assert.AreEqual ("testName", finalSer.name, "A7");
		}

		[Test]
		public void ChangesToReturnedByteArrayNotLaterWrittenBack ()
		{
			ResXDataNode originalNode, returnedNode, finalNode;
			originalNode = GetNodeEmdeddedBytes1To10 ();
			returnedNode = GetNodeFromResXReader (originalNode);

			Assert.IsNotNull (returnedNode, "#A1");

			object val = returnedNode.GetValue ((ITypeResolutionService) null);
			Assert.IsInstanceOfType (typeof (byte []), val, "#A2");

			byte[] newBytes = (byte[]) val;
			Assert.AreEqual (1, newBytes [0], "A3");
			newBytes [0] = 99;

			finalNode = GetNodeFromResXReader (returnedNode);
			
			Assert.IsNotNull (finalNode, "#A4");

			object finalVal = finalNode.GetValue ((ITypeResolutionService) null);
			Assert.IsInstanceOfType (typeof (byte []), finalVal, "#A5");
			byte [] finalBytes = (byte []) finalVal;
			// would be 99 if written back
			Assert.AreEqual (1,finalBytes [0],"A6");
		}

		[Test]
		public void OriginalTypeUsedSerializableWhenWritingBackToResX ()
		{
			// check although calls subsequent to an ITRS being supplied to GetValue return that resolved type
			// when the node is written back using ResXResourceWriter it uses the original type
			ResXDataNode originalNode, returnedNode, finalNode;

			originalNode = GetNodeEmdeddedSerializable ();
			returnedNode = GetNodeFromResXReader (originalNode);
			
			Assert.IsNotNull (returnedNode, "#A1");
			object val = returnedNode.GetValue (new ReturnSerializableSubClassITRS ());
			Assert.IsInstanceOfType (typeof (serializableSubClass), val, "#A2");

			finalNode = GetNodeFromResXReader (returnedNode);
			Assert.IsNotNull (finalNode, "#A3");

			object finalVal = finalNode.GetValue ((ITypeResolutionService) null);
			Assert.IsNotInstanceOfType (typeof (serializableSubClass), finalVal, "#A4");
			Assert.IsInstanceOfType (typeof (serializable), finalVal, "#A5");
		}

		static string typeconResXInvalidMimeTypeAndType =
@"<?xml version=""1.0"" encoding=""utf-8""?>
<root>
  
  <resheader name=""resmimetype"">
	<value>text/microsoft-resx</value>
  </resheader>
  <resheader name=""version"">
	<value>2.0</value>
  </resheader>
  <resheader name=""reader"">
	<value>System.Resources.ResXResourceReader, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
  </resheader>
  <resheader name=""writer"">
	<value>System.Resources.ResXResourceWriter, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
  </resheader>
  <data name=""test"" type=""A.type"" mimetype=""application/xxxx"">
	<value>42</value>
  </data>
</root>";

		static string fileRefResX =
@"<?xml version=""1.0"" encoding=""utf-8""?>
<root>
  <resheader name=""resmimetype"">
    <value>text/microsoft-resx</value>
  </resheader>
  <resheader name=""version"">
    <value>2.0</value>
  </resheader>
  <resheader name=""reader"">
    <value>System.Resources.ResXResourceReader, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
  </resheader>
  <resheader name=""writer"">
    <value>System.Resources.ResXResourceWriter, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
  </resheader>
  <assembly alias=""System.Windows.Forms"" name=""System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089"" />
  <data name=""anode"" type=""System.Resources.ResXFileRef, System.Windows.Forms"">
    <value>file.name;type.name</value>
  </data>
</root>";
		
		static string fileRefResXCorrupted = 
@"<?xml version=""1.0"" encoding=""utf-8""?>
<root>
  
  <resheader name=""resmimetype"">
	<value>text/microsoft-resx</value>
  </resheader>
  <resheader name=""version"">
	<value>2.0</value>
  </resheader>
  <resheader name=""reader"">
	<value>System.Resources.ResXResourceReader, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
  </resheader>
  <resheader name=""writer"">
	<value>System.Resources.ResXResourceWriter, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
  </resheader>
  <assembly alias=""System.Windows.Forms"" name=""System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089"" />
  <data name=""test"" type=""System.Resources.ResXFileRef, System.Windows.Forms"">
	<value>.\somethingthatdoesntexist.txt;System.String, System.Windows.Forms_test_net_2_0, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null;AValidCultureStringThisIsNot</value>
  </data>
</root>";

		static string serializedResXCorruped =
@"<?xml version=""1.0"" encoding=""utf-8""?>
<root>
  
  <resheader name=""resmimetype"">
	<value>text/microsoft-resx</value>
  </resheader>
  <resheader name=""version"">
	<value>2.0</value>
  </resheader>
  <resheader name=""reader"">
	<value>System.Resources.ResXResourceReader, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
  </resheader>
  <resheader name=""writer"">
	<value>System.Resources.ResXResourceWriter, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
  </resheader>
  <data name=""test"" mimetype=""application/x-microsoft.net.object.binary.base64"">
	<value>
		AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
		AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
		AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
		AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
</value>
  </data>
</root>";

		static string serializedResXInvalidMimeType =
@"<?xml version=""1.0"" encoding=""utf-8""?>
<root>
  
  <resheader name=""resmimetype"">
	<value>text/microsoft-resx</value>
  </resheader>
  <resheader name=""version"">
	<value>2.0</value>
  </resheader>
  <resheader name=""reader"">
	<value>System.Resources.ResXResourceReader, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
  </resheader>
  <resheader name=""writer"">
	<value>System.Resources.ResXResourceWriter, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
  </resheader>
  <data name=""test"" mimetype=""application/xxxx"">
	<value>
		AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
		AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
		AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
		AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
</value>
  </data>
</root>";

		static string convertableResXWithoutAssemblyName =
@"<?xml version=""1.0"" encoding=""utf-8""?>
<root>
  
  <resheader name=""resmimetype"">
	<value>text/microsoft-resx</value>
  </resheader>
  <resheader name=""version"">
	<value>2.0</value>
  </resheader>
  <resheader name=""reader"">
	<value>System.Resources.ResXResourceReader, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
  </resheader>
  <resheader name=""writer"">
	<value>System.Resources.ResXResourceWriter, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
  </resheader>
  
  <data name=""test"" type=""DummyAssembly.Convertable"">
	<value>im a name	im a value</value>
  </data>
</root>";

	}
}