buildframework/helium/sf/java/checktools/src/com/nokia/helium/checktools/HeliumToolsCheckerMain.java
author wbernard
Fri, 13 Aug 2010 14:59:05 +0300
changeset 628 7c4a911dc066
parent 587 85df38eb4012
permissions -rw-r--r--
helium_11.0.0-e00f171ca185
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
 */
628
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 587
diff changeset
    17
587
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    18
package com.nokia.helium.checktools;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    19
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    20
import java.io.FileInputStream;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    21
import java.io.IOException;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    22
import java.util.Properties;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    23
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    24
/**
628
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 587
diff changeset
    25
 * HeliumToolsCheckerMain is the main class which is used to trigger the checking of basic tools
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 587
diff changeset
    26
 * required by the Helium.
587
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    27
 * 
628
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 587
diff changeset
    28
 * Note: HeliumToolsCheckerMain requires a '-config' parameter to be passed as the argument. The
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 587
diff changeset
    29
 * config parameter should be followed by a valid location of the configuration file.
587
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    30
 * 
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    31
 */
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    32
public final class HeliumToolsCheckerMain {
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    33
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    34
    private Properties configuration;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    35
    private CheckEngine checkEngine;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    36
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    37
    /**
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    38
     * Create an instance of HeliumToolsCheckerMain.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    39
     * 
628
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 587
diff changeset
    40
     * @param configFile is the config file to read.
587
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    41
     */
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    42
    private HeliumToolsCheckerMain(String configFile) {
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    43
        loadConfiguration(configFile);
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    44
        checkEngine = new CheckEngine(configuration);
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    45
    }
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    46
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    47
    /**
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    48
     * Check ant version.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    49
     * 
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    50
     */
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    51
    private void checkAnt() {
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    52
        try {
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    53
            checkEngine.verifyAntVersion();
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    54
        } catch (CheckToolException e) {
628
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 587
diff changeset
    55
            println("*** Error: " + e.getMessage());
587
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    56
        }
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    57
    }
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    58
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    59
    /**
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    60
     * Check python version.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    61
     */
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    62
    private void checkPython() {
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    63
        try {
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    64
            checkEngine.verifyPythonVersion();
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    65
        } catch (CheckToolException e) {
628
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 587
diff changeset
    66
            println("*** Error: " + e.getMessage());
587
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    67
        }
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    68
    }
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
     * Method to check whether the tool check failed or not.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    72
     * 
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    73
     * @return true, if the tool check failed with errors; otherwise false.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    74
     */
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    75
    private boolean checkFailed() {
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    76
        return checkEngine.getErrorCount() > 0;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    77
    }
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    78
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    79
    /**
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    80
     * Method loads the configuration details from the given file.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    81
     * 
628
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 587
diff changeset
    82
     * @param configFile is the configuration file to be loaded.
587
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    83
     */
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    84
    private void loadConfiguration(String configFile) {
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    85
        try {
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    86
            configuration = new Properties();
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    87
            configuration.load(new FileInputStream(configFile));
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    88
        } catch (IOException th) {
628
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 587
diff changeset
    89
            println("Error occured while loading config file: " + configFile);
587
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    90
            System.exit(-1);
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    91
        }
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    92
    }
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    93
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    94
    /**
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    95
     * Main method to trigger tool check.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    96
     * 
628
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 587
diff changeset
    97
     * @param args contains command line arguments passed.
587
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    98
     * @throws Exception
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    99
     */
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   100
    public static void main(String[] args) throws Exception {
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   101
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   102
        String configFile = null;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   103
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   104
        // check for configuration file
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   105
        if (args.length == 2 && args[0].equalsIgnoreCase("-config")) {
628
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 587
diff changeset
   106
            if (args[1] == null || (args[1] != null && args[1].trim().isEmpty())) {
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 587
diff changeset
   107
                println("*** Error: Parameter '-config' not set for HeliumToolsCheckerMain");
587
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   108
                System.exit(-1);
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   109
            }
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   110
            configFile = args[1];
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   111
        }
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   112
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   113
        if (configFile != null) {
628
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 587
diff changeset
   114
            HeliumToolsCheckerMain checkerMain = new HeliumToolsCheckerMain(configFile);
587
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   115
            checkerMain.checkAnt();
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   116
            checkerMain.checkPython();
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   117
            if (checkerMain.checkFailed()) {
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   118
                System.exit(-1);
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   119
            }
628
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 587
diff changeset
   120
        }
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 587
diff changeset
   121
        else {
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 587
diff changeset
   122
            println("*** Error: Missing '-config' argument for HeliumToolsCheckerMain");
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 587
diff changeset
   123
            println("Usage: java [main-class-name] -config [location of configuration file]");
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 587
diff changeset
   124
            println("Example: java com.nokia.helium.checktools.HeliumToolsCheckerMain -config \"config/helium.basic.tools.config\"");
587
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   125
            System.exit(-1);
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   126
        }
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   127
    }
628
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 587
diff changeset
   128
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 587
diff changeset
   129
    @SuppressWarnings("PMD.SystemPrintln")
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 587
diff changeset
   130
    public static void println(String text) {
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 587
diff changeset
   131
        System.out.println(text);
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 587
diff changeset
   132
    }
587
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   133
}