Check war file before deploy / conditional deploy

Question

When using cargo to deploy to a remote server I would like to check with cargo or maven that the generated war have it's properties files filtered like expected.

Some phase in between should test a property file from war against some strings and so deploy or stop deployment.

there's built in on cargo to achieve this?

Answer 1

Not sure what are the properties files you're referring to therefore I assume that you refer to typical java *.properties files.

Anyway, I believe you should use: maven-enforcer-plugin and it's goal: enforce as that is the common way in maven to enforce some condition (the plugin uses term: rule) to be fulfilled.

I think you have more options here.

Option 1

Maybe you could check that prio to packaging to your war using:

maven-property-plugin - goal: read-project-properties (http://mojo.codehaus.org/properties-maven-plugin/usage.html)

  <plugin>
    <groupId>org.codehaus.mojo</groupId>
    <artifactId>properties-maven-plugin</artifactId>
    <version>1.0-alpha-2</version>
    <executions>
      <execution>
        <phase>???</phase>
        <goals>
          <goal>read-project-properties</goal>
        </goals>
        <configuration>
          <files>
            <file>your_file_to_check.properties</file>
          </files>
        </configuration>
      </execution>
    </executions>
  </plugin>

where you should:

• check the right phase to make sure the file is already filtered (http://maven.apache.org/guides/introduction/introduction-to-the-lifecycle.html)
• reference the file you want to check the properties of

And afterwards go for maven-enforcer-plugin goal: enforce and the rule: requireProperty (http://maven.apache.org/enforcer/enforcer-rules/requireProperty.html)

  <plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-enforcer-plugin</artifactId>
    <version>1.3.1</version>
    <executions>
      <execution>
        <id>enforce-property</id>
        <goals>
          <goal>enforce</goal>
        </goals>
        <configuration>
          <rules>
            <requireProperty>
              <property>your_property_to_check</property>
              <message>You must set a your_property_to_check property!</message>
              <regex>regex</regex>
              <regexMessage>violation txt</regexMessage>
            </requireProperty>               
          </rules>
          <fail>true</fail>
        </configuration>
      </execution>
    </executions>
  </plugin>

where:

• your_property_to_check should be replaced with the real one as well as
• regex should be defined

Option 2

If that is not feasible and you want to check property inside war file, you might need to write your own rule.

That should not be a big deal as java has zip reading as well as properties files loading in it's standard API. To learn how to write custom rule, see: http://maven.apache.org/enforcer/enforcer-api/writing-a-custom-rule.html

Btw. I'd be quite curious to understand why would someone want to do check some property on each deployment? Is the case that your input (property files you filter) are dynamically generated/changed? Otherwise I doubt you need it once you check it works.