Class Verifier

    • Method Detail

      • setLocalRepo

        public void setLocalRepo​(String localRepo)
      • resetStreams

        public void resetStreams()
      • displayStreamBuffers

        public void displayStreamBuffers()
      • verifyTextInLog

        public void verifyTextInLog​(String text)
                             throws VerificationException
        Throws an exception if the text is not present in the log.
        Parameters:
        text - the text to assert present
        Throws:
        VerificationException - if text is not found in log
      • stripAnsi

        public static String stripAnsi​(String msg)
      • loadLines

        public List<String> loadLines​(String filename,
                                      String encoding)
                               throws IOException
        Loads the (non-empty) lines of the specified text file.
        Parameters:
        filename - The path to the text file to load, relative to the base directory, must not be null.
        encoding - The character encoding of the file, may be null or empty to use the platform default encoding.
        Returns:
        The list of (non-empty) lines from the text file, can be empty but never null.
        Throws:
        IOException - If the file could not be loaded.
        Since:
        1.2
      • getArtifactPath

        public String getArtifactPath​(String gid,
                                      String aid,
                                      String version,
                                      String ext,
                                      String classifier)
        Returns the absolute path to the artifact denoted by groupId, artifactId, version, extension and classifier.
        Parameters:
        gid - The groupId, must not be null.
        aid - The artifactId, must not be null.
        version - The version, must not be null.
        ext - The extension, must not be null.
        classifier - The classifier, may be null to be omitted.
        Returns:
        the absolute path to the artifact denoted by groupId, artifactId, version, extension and classifier, never null.
      • getArtifactMetadataPath

        public String getArtifactMetadataPath​(String gid,
                                              String aid,
                                              String version)
        Gets the path to the local artifact metadata. Note that the method does not check whether the returned path actually points to existing metadata.
        Parameters:
        gid - The group id, must not be null.
        aid - The artifact id, must not be null.
        version - The artifact version, may be null.
        Returns:
        The (absolute) path to the local artifact metadata, never null.
      • getArtifactMetadataPath

        public String getArtifactMetadataPath​(String gid,
                                              String aid,
                                              String version,
                                              String filename)
        Gets the path to a file in the local artifact directory. Note that the method does not check whether the returned path actually points to an existing file.
        Parameters:
        gid - The group id, must not be null.
        aid - The artifact id, may be null.
        version - The artifact version, may be null.
        filename - The filename to use, must not be null.
        Returns:
        The (absolute) path to the local artifact metadata, never null.
      • getArtifactMetadataPath

        public String getArtifactMetadataPath​(String gid,
                                              String aid)
        Gets the path to the local artifact metadata. Note that the method does not check whether the returned path actually points to existing metadata.
        Parameters:
        gid - The group id, must not be null.
        aid - The artifact id, must not be null.
        Returns:
        The (absolute) path to the local artifact metadata, never null.
      • deleteArtifacts

        public void deleteArtifacts​(String gid)
                             throws IOException
        Deletes all artifacts in the specified group id from the local repository.
        Parameters:
        gid - The group id whose artifacts should be deleted, must not be null.
        Throws:
        IOException - If the artifacts could not be deleted.
        Since:
        1.2
      • deleteArtifacts

        public void deleteArtifacts​(String gid,
                                    String aid,
                                    String version)
                             throws IOException
        Deletes all artifacts in the specified g:a:v from the local repository.
        Parameters:
        gid - The group id whose artifacts should be deleted, must not be null.
        aid - The artifact id whose artifacts should be deleted, must not be null.
        version - The (base) version whose artifacts should be deleted, must not be null.
        Throws:
        IOException - If the artifacts could not be deleted.
        Since:
        1.3
      • deleteDirectory

        public void deleteDirectory​(String path)
                             throws IOException
        Deletes the specified directory.
        Parameters:
        path - The path to the directory to delete, relative to the base directory, must not be null.
        Throws:
        IOException - If the directory could not be deleted.
        Since:
        1.2
      • writeFile

        public void writeFile​(String path,
                              String contents)
                       throws IOException
        Writes a text file with the specified contents. The contents will be encoded using UTF-8.
        Parameters:
        path - The path to the file, relative to the base directory, must not be null.
        contents - The contents to write, must not be null.
        Throws:
        IOException - If the file could not be written.
        Since:
        1.2
      • filterFile

        public File filterFile​(String srcPath,
                               String dstPath,
                               String fileEncoding,
                               Map<String,​String> filterProperties)
                        throws IOException
        Filters a text file by replacing some user-defined tokens.
        Parameters:
        srcPath - The path to the input file, relative to the base directory, must not be null.
        dstPath - The path to the output file, relative to the base directory and possibly equal to the input file, must not be null.
        fileEncoding - The file encoding to use, may be null or empty to use the platform's default encoding.
        filterProperties - The mapping from tokens to replacement values, must not be null.
        Returns:
        The path to the filtered output file, never null.
        Throws:
        IOException - If the file could not be filtered.
        Since:
        1.2
      • filterFile

        @Deprecated
        public File filterFile​(String srcPath,
                               String dstPath,
                               String fileEncoding,
                               Properties filterProperties)
                        throws IOException
        There are 226 references to this method in Maven core ITs. In most (all?) cases it is used together with newDefaultFilterProperties(). Need to remove both methods and update all clients eventually/
        Parameters:
        srcPath - The path to the input file, relative to the base directory, must not be null.
        dstPath - The path to the output file, relative to the base directory and possibly equal to the input file, must not be null.
        fileEncoding - The file encoding to use, may be null or empty to use the platform's default encoding.
        filterProperties - The mapping from tokens to replacement values, must not be null.
        Returns:
        The path to the filtered output file, never null.
        Throws:
        IOException - If the file could not be filtered.
      • newDefaultFilterProperties

        public Properties newDefaultFilterProperties()
        Gets a new copy of the default filter properties. These default filter properties map the tokens "@basedir@" and "@baseurl@" to the test's base directory and its base file: URL, respectively.
        Returns:
        The (modifiable) map with the default filter properties, never null.
        Since:
        1.2
      • assertFilePresent

        public void assertFilePresent​(String file)
      • assertFileMatches

        public void assertFileMatches​(String file,
                                      String regex)
        Check that given file's content matches an regular expression. Note this method also checks that the file exists and is readable.
        Parameters:
        file - the file to check.
        regex - a regular expression.
        See Also:
        Pattern
      • assertFileNotPresent

        public void assertFileNotPresent​(String file)
      • assertArtifactNotPresent

        public void assertArtifactNotPresent​(String org,
                                             String name,
                                             String version,
                                             String ext)
      • getExecutable

        public String getExecutable()
      • getCliOptions

        public List<String> getCliOptions()
      • setCliOptions

        public void setCliOptions​(List<String> cliOptions)
      • addCliOption

        public void addCliOption​(String option)
      • getSystemProperties

        public Properties getSystemProperties()
      • setSystemProperties

        public void setSystemProperties​(Properties systemProperties)
      • setSystemProperty

        public void setSystemProperty​(String key,
                                      String value)
      • getEnvironmentVariables

        public Map<String,​String> getEnvironmentVariables()
      • setEnvironmentVariables

        public void setEnvironmentVariables​(Map<String,​String> environmentVariables)
      • setEnvironmentVariable

        public void setEnvironmentVariable​(String key,
                                           String value)
      • getVerifierProperties

        public Properties getVerifierProperties()
      • setVerifierProperties

        public void setVerifierProperties​(Properties verifierProperties)
      • isAutoclean

        public boolean isAutoclean()
      • setAutoclean

        public void setAutoclean​(boolean autoclean)
      • getBasedir

        public String getBasedir()
      • getLogFileName

        public String getLogFileName()
        Gets the name of the file used to log build output.
        Returns:
        The name of the log file, relative to the base directory, never null.
        Since:
        1.2
      • setLogFileName

        public void setLogFileName​(String logFileName)
        Sets the name of the file used to log build output.
        Parameters:
        logFileName - The name of the log file, relative to the base directory, must not be empty or null.
        Since:
        1.2
      • setDebug

        public void setDebug​(boolean debug)
      • isMavenDebug

        public boolean isMavenDebug()
      • setMavenDebug

        public void setMavenDebug​(boolean mavenDebug)
      • setForkJvm

        public void setForkJvm​(boolean forkJvm)
      • isDebugJvm

        public boolean isDebugJvm()
      • setDebugJvm

        public void setDebugJvm​(boolean debugJvm)
      • getLocalRepoLayout

        public String getLocalRepoLayout()
      • setLocalRepoLayout

        public void setLocalRepoLayout​(String localRepoLayout)
      • getLocalRepository

        public String getLocalRepository()