How to search for a string in files with Ant (make sure certain string isn’t found in source files)

by

You might consider using fileset selectors to do this. Selectors allow you to choose files based on content, size, editability and so on. You can combine selectors with name-based includes and excludes, or patternsets.

Below is an example. The second fileset is derived from the first, with a selector that simply matches on file content. For more sophisticated matching there is the containsregexp selector. The result is a fileset containing only files matching the string. A fail task with a resourcecount condition is then used to fail the build, unless that fileset is empty.

<property name="src.dir" value="src" />
<property name="search.string" value="BAD" />

<fileset id="existing" dir="${src.dir}">
    <patternset id="files">
        <!-- includes/excludes for your source here -->
    </patternset>
</fileset>

<fileset id="matches" dir="${src.dir}">
    <patternset refid="files" />
    <contains text="${search.string}" />
</fileset>

<fail message="Found '${search.string}' in one or more files in '${src.dir}'">
    <condition>
        <resourcecount when="greater" count="0" refid="matches" />
    </condition>
</fail>

(Old answer): If adjusting or reusing filesets might be problematic, here’s an illustration of a relatively simple alternative.

The idea is to make a copy of the files,
then replace the string you wish to search for
with some flag value in the copied files.
This will update the last modified time on any matching file.
The uptodate task can then be used to look for affected files.
Finally, unless no files matched, you can fail the build.

<property name="src.dir" value="src" />
<property name="work.dir" value="work" />
<property name="search.string" value="BAD" />

<delete dir="${work.dir}" />
<mkdir dir="${work.dir}" />
<fileset dir="${src.dir}" id="src.files">
    <include name="*.txt" />
</fileset>
<copy todir="${work.dir}" preservelastmodified="true">
    <fileset refid="src.files" />
</copy>
<fileset dir="${work.dir}" id="work.files">
    <include name="*.txt" />
</fileset>
<replaceregexp match="${search.string}"
               replace="FOUND_${search.string}">
    <fileset refid="work.files" />
</replaceregexp>
<uptodate property="files.clean">
    <srcfiles refid="work.files" />
    <regexpmapper from="(.*)" to="${basedir}/${src.dir}/\1" />
</uptodate>
<fail message="Found '${search.string}' in one or more files in dir '${src.dir}'"
      unless="files.clean" />

More Related Contents:

  1. grep a file, but show several surrounding lines?
  2. NoClassDefFoundError – Eclipse and Android
  3. Solr vs. ElasticSearch [closed]
  4. JQGrid Toolbar Searching: search for multiple words for a column
  5. grep: show lines surrounding each match
  6. using OR and NOT in solr query
  7. Searching for value of any field in MongoDB without explicitly naming it
  8. jqGrid Filtering Records
  9. How can I search for a commit message on GitHub?
  10. How to search on GitHub to get exact string matches, including special characters
  11. Ant to Maven – multiple build targets
  12. How to include forward slash in vi search & replace
  13. How do I implement Search Functionality in a website? [closed]
  14. Make ant quiet without the -q flag?
  15. How to create a simple google maps address search with autocomplete in flutter and get latitude and longitude?
  16. Solr exact word search
  17. Is there a way to modify fetched results with a predicate after they are initialized?
  18. How do I search Google Spreadsheets?
  19. How to put a delay on AngularJS instant search?
  20. how do I normalise a solr/lucene score?
  21. How to do case insensitive search in Vim
  22. Tools to search for strings inside files without indexing [closed]
  23. What is the difference between graph search and tree search?
  24. What makes a “friendly URL”? [closed]
  25. “Did you mean?” feature in Lucene.net
  26. How do I reference external jar files in a common directory (not libs) to build android project using ant?
  27. Show Count of Matches in Vim
  28. ElasticSearch — boosting relevance based on field value
  29. How do I remove all default Webkit search field styling?
  30. Why is my webpack bundle.js and vendor.bundle.js so incredibly big?

Leave a Comment