buildframework/helium/sf/java/metadata/src/com/nokia/helium/metadata/ant/conditions/MetaDataLogCondition.java
author wbernard
Thu, 22 Jul 2010 17:08:43 +0300
branchhelium-9.0
changeset 618 df88fead2976
parent 587 85df38eb4012
child 628 7c4a911dc066
permissions -rw-r--r--
helium_9.0.5-4399343f4f50
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
587
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     1
/*
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     2
 * Copyright (c) 2007-2008 Nokia Corporation and/or its subsidiary(-ies).
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     3
 * All rights reserved.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     4
 * This component and the accompanying materials are made available
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     5
 * under the terms of the License "Eclipse Public License v1.0"
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     6
 * which accompanies this distribution, and is available
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     7
 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     8
 *
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     9
 * Initial Contributors:
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    10
 * Nokia Corporation - initial contribution.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    11
 *
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    12
 * Contributors:
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    13
 *
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    14
 * Description:  
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    15
 *
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    16
 */
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    17
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    18
package com.nokia.helium.metadata.ant.conditions;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    19
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    20
import java.io.File;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    21
import com.nokia.helium.jpa.ORMReader;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    22
import com.nokia.helium.jpa.entity.metadata.Metadata;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    23
import org.apache.tools.ant.BuildException;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    24
import org.apache.tools.ant.Project;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    25
import org.apache.tools.ant.taskdefs.condition.Condition;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    26
import org.apache.tools.ant.types.DataType;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    27
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    28
/**
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    29
 * This class implements a Ant Condition which report true if it finds any
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    30
 * matching severity inside a database for an XML log.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    31
 * 
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    32
 * Example:
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    33
 * <pre>
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    34
 * &lt;target name=&quot;fail-on-build-error&quot;&gt;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    35
 *   &lt;fail message=&quot;The build contains errors&quot;&gt;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    36
 *     &lt;hlm:metadataHasSeverity log=&quot;my.log&quot; db=&quot;my.db&quot; severity=&quot;error&quot;/&gt;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    37
 *   &lt;/fail&gt;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    38
 * &lt;/target&gt;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    39
 * </pre>
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    40
 * 
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    41
 * The condition will eval as true if the my.db contains error stored for my.log file.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    42
 * 
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    43
 * @ant.type name="metadataHasSeverity" category="Metadata"
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    44
 */
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    45
public class MetaDataLogCondition extends DataType implements Condition {
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    46
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    47
    // The severity to count
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    48
    private String severity;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    49
    private String logFile;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    50
    private File fileName;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    51
    private boolean countMissing = true;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    52
    
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    53
    /**
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    54
     * Sets which severity will be counted.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    55
     * 
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    56
     * @param severity
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    57
     * @ant.required
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    58
     */
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    59
    public void setSeverity(String severity) {
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    60
        this.severity = severity;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    61
    }
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    62
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    63
    public void setDb(File file) {
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    64
        fileName = file;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    65
    }
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    66
    
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    67
    public void setLog(String log) {
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    68
        logFile = log;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    69
    }
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    70
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    71
    public void setCountMissing(boolean countMissing) {
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    72
        this.countMissing = countMissing;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    73
    }
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    74
    
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    75
    /**
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    76
     * Get the number of a particular severity.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    77
     * 
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    78
     * @return the number of a particular severity.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    79
     */
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    80
    public int getSeverity() {
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    81
        if (fileName == null || !fileName.exists() || logFile == null) {
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    82
            //this.log("Error: Log file does not exist " + fileName);
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    83
            return -1;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    84
        }
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    85
        if (severity == null)
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    86
            throw new BuildException("'severity' attribute is not defined");
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    87
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    88
        log("Looking for severity '" + severity + "' under '" + fileName.getAbsolutePath() + "'", Project.MSG_DEBUG);
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    89
        
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    90
        Metadata.PriorityEnum prty = null;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    91
        if (severity.equalsIgnoreCase("ERROR")) {
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    92
            prty = Metadata.PriorityEnum.ERROR;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    93
        } else if (severity.equalsIgnoreCase("WARNING")) {
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    94
            prty = Metadata.PriorityEnum.WARNING;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    95
        } else if (severity.equalsIgnoreCase("FATAL")) {
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    96
            prty = Metadata.PriorityEnum.FATAL;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    97
        } else if (severity.equalsIgnoreCase("INFO")) {
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    98
            prty = Metadata.PriorityEnum.INFO;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    99
        } else if (severity.equalsIgnoreCase("REMARK")) {
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   100
            prty = Metadata.PriorityEnum.REMARK;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   101
        }
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   102
        else
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   103
            throw new BuildException("'severity' attribute is not valid");
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   104
        
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   105
        // log file under the DB is always represented with / and not \.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   106
        String logname = logFile.replace('\\', '/'); 
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   107
        String query = "select Count(m.id) from MetadataEntry m JOIN  m.logFile as l JOIN m.priority as p where l.path like '%" + logname + "' and UPPER(p.priority)='" + severity.toUpperCase() + "'";
618
df88fead2976 helium_9.0.5-4399343f4f50
wbernard
parents: 587
diff changeset
   108
        ORMReader reader = new ORMReader(fileName.getAbsolutePath());
df88fead2976 helium_9.0.5-4399343f4f50
wbernard
parents: 587
diff changeset
   109
        Number number = (Number)reader.executeSingleResult(query, null);
df88fead2976 helium_9.0.5-4399343f4f50
wbernard
parents: 587
diff changeset
   110
        int retValue = number.intValue();
587
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   111
        // Looking for missing file as error
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   112
        if (countMissing && prty == Metadata.PriorityEnum.ERROR) {
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   113
            String queryMissing = "select Count(m.id) from WhatLogEntry m JOIN m.component as c JOIN c.logFile as l where l.path like '%" + logname + "' and m.missing=1";
618
df88fead2976 helium_9.0.5-4399343f4f50
wbernard
parents: 587
diff changeset
   114
            Number numberMissing = (Number) reader.executeSingleResult(queryMissing, null);
df88fead2976 helium_9.0.5-4399343f4f50
wbernard
parents: 587
diff changeset
   115
            retValue = number.intValue() + numberMissing.intValue();
587
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   116
        }
618
df88fead2976 helium_9.0.5-4399343f4f50
wbernard
parents: 587
diff changeset
   117
        reader.close();
df88fead2976 helium_9.0.5-4399343f4f50
wbernard
parents: 587
diff changeset
   118
        return retValue;
587
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   119
    }
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   120
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   121
    /**
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   122
     * This method open the defined file and count the number of message tags
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   123
     * with their severity attribute matching the configured one.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   124
     * 
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   125
     * @return if true if message with the defined severity have been found.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   126
     */
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   127
    public boolean eval() {
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   128
        int severity = getSeverity();
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   129
        if (severity < 0) {
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   130
            return false;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   131
        }
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   132
        return severity > 0;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   133
    }
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   134
}