Is there any way to do a "Replace Or Insert" using web.config transformation?

asp.netWeb Config-TransformXsltXdt Transform

asp.net Problem Overview


I'm using web.config transformation as described in the below post in order to generate configs for different environments.

http://vishaljoshi.blogspot.com/2009/03/web-deployment-webconfig-transformation_23.html

I can do a "Replace" transformation by matching on the key, e.g.

<add key="Environment" value="Live" xdt:Transform="Replace" xdt:Locator="Match(key)" />

And I can do "Inserts" e.g.

<add key="UseLivePaymentService" value="true" xdt:Transform="Insert" />

But what I would really find useful is a ReplaceOrInsert transformation, as I can't always rely on the original config file having/not having a certain key.

Is there any way to do this?

asp.net Solutions


Solution 1 - asp.net

In conjunction with xdt:Transform="Remove" use xdt:Transform="InsertIfMissing" in VS2012.

<authorization xdt:Transform="Remove" />
<authorization xdt:Transform="InsertIfMissing">
  <deny users="?"/>
  <allow users="*"/>
</authorization>

Solution 2 - asp.net

I found a cheap workaround. It ain't pretty and won't work very well if you have a lot of elements that needs to be "Replace Or Insert".

Do a "Remove" and then an "InsertAfter|InsertBefore".

For example,

<authorization xdt:Transform="Remove" />
<authorization xdt:Transform="InsertAfter(/configuration/system.web/authentication)">
  <deny users="?"/>
  <allow users="*"/>
</authorization>

Solution 3 - asp.net

Use the InsertIfMissing transformation to ensure that the appSetting exists.
Then use the Replace transformation to set its value.

<appSettings>
  <add key="Environment" xdt:Transform="InsertIfMissing" xdt:Locator="Match(key)" />
  <add key="Environment" value="Live" xdt:Transform="Replace" xdt:Locator="Match(key)" />
</appSettings>

You could also use the SetAttributes transformation instead of Replace. The difference is that SetAttributes does not touch child nodes.

<appSettings>  
  <add key="UseLivePaymentService" xdt:Transform="InsertIfMissing" xdt:Locator="Match(key)" />
  <add key="UseLivePaymentService" value="true" xdt:Transform="SetAttributes" xdt:Locator="Match(key)" />
</appSettings>

These techniques are much better than remove+insert because existing nodes are not moved to the bottom of their parent node. New nodes are appended at the end. Existing nodes stay where they are in the source file.

This answer applies only to newer versions of Visual Studio (2012 or newer).

Solution 4 - asp.net

A better method for me was to insert the element only if it doesn't exist since I am only setting certain attributes. Removing the element would discard any other attributes of the main element if they existed.

example: web.config (without element)

<serviceBehaviors>
	<behavior name="Wcf.ServiceImplementation.AllDigitalService_Behavior">
		<serviceMetadata httpGetEnabled="true" />
	</behavior>
</serviceBehaviors>

web.config (with element)

<serviceBehaviors>
	<behavior name="Wcf.ServiceImplementation.AllDigitalService_Behavior">
		<serviceDebug httpsHelpPageEnabled="true" />
		<serviceMetadata httpGetEnabled="true" />
	</behavior>
</serviceBehaviors>

Using the Locator with an XPath expression, I add the node if it doesn't exist and then set my attribute:

<serviceDebug xdt:Transform="Insert"
  xdt:Locator="XPath(/configuration/system.serviceModel/behaviors/serviceBehaviors/behavior[not(serviceDebug)])" />
<serviceDebug includeExceptionDetailInFaults="true" xdt:Transform="SetAttributes" />

both resulting web.config files have includeExceptionDetailInFaults="true" and the second one preserves the httpsHelpPageEnabled attribute where the remove/insert method would not.

Attributions

All content for this solution is sourced from the original question on Stackoverflow.

The content on this page is licensed under the Attribution-ShareAlike 4.0 International (CC BY-SA 4.0) license.

Content TypeOriginal AuthorOriginal Content on Stackoverflow
QuestionChris HainesView Question on Stackoverflow
Solution 1 - asp.netADW334034View Answer on Stackoverflow
Solution 2 - asp.netan phuView Answer on Stackoverflow
Solution 3 - asp.netSteven LiekensView Answer on Stackoverflow
Solution 4 - asp.netDanView Answer on Stackoverflow