ssConfig versus ssConfigFile

[martindholmes]

Discovered when testing migration from v1 to v2: we should probably only have one of these vars to reduce confusion.

[joeytakeda]

I've just been bitten by this -- I have a folder structure like this:

.
├── build.xml
├── _public/
└── static
    └── lib/
        ├── staticSearch/
        │   └── EDITION
        └── staticSearch_config.xml

And here is what the build target looks like (with relevant properties):

  <property name="staticSearch.dir" value="${static.dir}/lib/staticSearch"/>
  <property name="ssConfigFile" value="${static.dir}/staticSearch_config.xml"/>
  <property name="ssVerbose" value="false"/>
  <property name="ssTarget" value="allButValidate"/>

  <target name="search.build" depends="getCommitHash">
    <ant antfile="${staticSearch.dir}/build.xml" 
      target="${ssTarget}" inheritall="false">
      <property name="ssConfigFile" value="${ssConfigFile}"/>
      <property name="ssVerbose" value="${ssVerbose}"/>
    </ant>
  </target>

But when I go to run the auto-conversion, I get this:

 ant search 
Buildfile: /Users/takeda/projects/wilde/build.xml

getCommitHash:

search.build:

checkConfigVersion:
     [echo] Checking version of config file /Users/takeda/projects/wilde/static/lib/staticSearch/configTest.xml...

convertConfigFile:
    [input] Your config file is for version 1 of staticSearch.
    [input]  It will be converted to version 2 format.
    [input]  Would you like to overwrite the existing file or 
    [input]  create a new file? (o=overwrite, n=new) (o, [n])
o

BUILD FAILED
/Users/takeda/projects/wilde/build.xml:130: The following error occurred while executing this line:
/Users/takeda/projects/wilde/static/lib/staticSearch/build.xml:262: The following error occurred while executing this line:
/Users/takeda/projects/wilde/static/lib/staticSearch/build.xml:285: Warning: Could not find file /Users/takeda/projects/wilde/static/lib/staticSearch/configTest.xml to copy.

Total time: 9 seconds

I think the problem comes from the conversion target reconstructing the path (e.g. using ${ssBaseDir.converted}/${ssConfig} rather than using ssConfigFile):

staticSearch/build.xml

Lines 265 to 301 in d1219a3

	<target name="convertConfigFile">
	<description>
	TARGET convertConfigFile
	This runs an identity transform on the supplied config
	file to create from it a version 2 file, and then reports
	the outcome to the user.
	</description>
	<input addproperty="outputStrategy"
	message="Your config file is for version 1 of staticSearch.&#x0a;
	It will be converted to version 2 format.&#x0a;
	Would you like to overwrite the existing file or &#x0a;
	create a new file? (o=overwrite, n=new)"
	validargs="o,n"
	defaultvalue="n"/>
	<!-- If overwriting, we'll make sure a backup is created first
	in case something goes wrong. -->
	<if>
	<equals arg1="${outputStrategy}" arg2="o"/>
	<then>
	<copy file="${ssBaseDir.converted}/${ssConfig}" tofile="${ssBaseDir.converted}/${ssConfig}.BAK"/>
	<echo message="A backup of your config file has been created: ${ssBaseDir.converted}/${ssConfig}.BAK"/>
	</then>
	</if>
	<!--<echo message="${outputStrategy}"/>-->
	<java classpath="${ssSaxon}" classname="net.sf.saxon.Transform" failonerror="true" fork="true">
	<arg value="-xsl:${ssBaseDir.converted}/xsl/convert_v1_to_v2.xsl"/>
	<arg value="-s:${ssBaseDir.converted}/${ssConfig}"/>
	<arg value="--suppressXsltNamespaceCheck:on"/>
	<arg value="ssBaseDir=${ssBaseDir.converted}"/>
	<arg value="ssVerbose=${ssVerbose}"/>
	<arg value="output=${outputStrategy}"/>
	<arg value="ssSchemaPath=${ssSchemaPath.rel}"/>
	</java>
	<fail message="Terminating this build. Please restart the build using your new configuration file."/>
	</target>

So I think the solution is fairly simple -- always use ssConfigFile rather than ssConfig once we're in the build process.

[joeytakeda]

PR #379 now submitted to fix this