/*
    * Licensed to the Apache Software Foundation (ASF) under one
    * or more contributor license agreements.  See the NOTICE file
    * distributed with this work for additional information
    * regarding copyright ownership.  The ASF licenses this file
    * to you under the Apache License, Version 2.0 (the
    * "License"); you may not use this file except in compliance
    * with the License.  You may obtain a copy of the License at
    *
   * http://www.apache.org/licenses/LICENSE-2.0
   *
   * Unless required by applicable law or agreed to in writing,
   * software distributed under the License is distributed on an
   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
   * KIND, either express or implied.  See the License for the
   * specific language governing permissions and limitations
   * under the License.
   */
  package org.apache.chemistry.opencmis.tck.runner;
  
  import java.io.BufferedReader;
  import java.io.File;
  import java.io.FileInputStream;
  import java.io.InputStream;
  import java.io.InputStreamReader;
  import java.util.ArrayList;
  import java.util.HashMap;
  import java.util.List;
  import java.util.Map;
  
  import org.apache.chemistry.opencmis.commons.impl.ClassLoaderUtil;
  import org.apache.chemistry.opencmis.tck.CmisTest;
  import org.apache.chemistry.opencmis.tck.CmisTestGroup;
  import org.apache.chemistry.opencmis.tck.CmisTestProgressMonitor;
  import org.apache.chemistry.opencmis.tck.impl.WrapperCmisTestGroup;
  
  /**
   * Base class for runners.
   */
  public abstract class AbstractRunner {
  
      public static final String OVERRIDE_KEY = "org.apache.chemistry";
      public static final String DEFAULT_TCK_GROUPS = "/cmis-tck-groups.txt";
      public static final String TCK_BUILD_TIMESTAMP = "/META-INF/build-timestamp.txt";
      public static final String TCK_BUILD_TIMESTAMP_PARAMETER = "org.apache.chemistry.opencmis.tck.timestamp";
  
      private Map<String, String> parameters;
      private final List<CmisTestGroup> groups = new ArrayList<CmisTestGroup>();
      private boolean isCanceled = false;
  
      // --- parameters ---
  
      public void setParameters(Map<String, String> orgParameters) {
          this.parameters = new HashMap<String, String>();
          if (orgParameters != null) {
              this.parameters.putAll(orgParameters);
          }
  
          // override with system properties
          for (Object key : System.getProperties().keySet()) {
              if (!key.toString().startsWith(OVERRIDE_KEY)) {
                  continue;
              }
  
              parameters.put(key.toString(), System.getProperties().getProperty(key.toString()));
          }
  
          // set TCK build timestamp
          parameters.put(TCK_BUILD_TIMESTAMP_PARAMETER, loadTCKTimestamp());
      }
  
      public void loadParameters(File file) throws Exception {
          if (file == null || !file.isFile()) {
              throw new IllegalArgumentException("File not found!");
          }
  
          loadParameters(new FileInputStream(file));
      }
  
      public void loadParameters(InputStream stream) throws Exception {
          if (stream == null) {
              throw new IllegalArgumentException("Stream is null!");
          }
  
          BufferedReader reader = null;
          Map<String, String> loadParams = new HashMap<String, String>();
  
          try {
              reader = new BufferedReader(new InputStreamReader(stream, "UTF-8"));
  
              String line;
              while ((line = reader.readLine()) != null) {
                  line = line.trim();
                  if (line.startsWith("#") || line.length() == 0) {
                      continue;
                  }
  
                  int x = line.indexOf('=');
                  if (x < 0) {
                     loadParams.put(line.trim(), "");
                 } else {
                     loadParams.put(line.substring(0, x).trim(), line.substring(x + 1).trim());
                 }
             }
 
             setParameters(loadParams);
         } finally {
             if (reader != null) {
                 try {
                     reader.close();
                 } catch (Exception e) {
                 }
             }
         }
     }
 
     public Map<String, String> getParameters() {
         return parameters;
     }
 
     private String loadTCKTimestamp() {
         StringBuilder result = new StringBuilder();
 
         InputStream stream = getClass().getResourceAsStream(TCK_BUILD_TIMESTAMP);
         if (stream != null) {
             try {
                 BufferedReader br = new BufferedReader(new InputStreamReader(stream));
 
                 String s = null;
                 while ((s = br.readLine()) != null) {
                     result.append(s);
                 }
 
                 br.close();
             } catch (Exception e) {
             }
         }
 
         return result.toString();
     }
 
     // --- groups ---
 
     public void loadDefaultTckGroups() throws Exception {
         loadGroups(this.getClass().getResourceAsStream(DEFAULT_TCK_GROUPS));
     }
 
     public void loadGroups(File file) throws Exception {
         if (file == null || !file.isFile()) {
             throw new IllegalArgumentException("File not found!");
         }
 
         loadGroups(new FileInputStream(file));
     }
 
     public void loadGroups(InputStream stream) throws Exception {
         if (stream == null) {
             throw new IllegalArgumentException("Stream is null!");
         }
 
         BufferedReader reader = null;
 
         try {
             reader = new BufferedReader(new InputStreamReader(stream, "UTF-8"));
 
             String line;
             while ((line = reader.readLine()) != null) {
                 line = line.trim();
                 if (line.startsWith("#") || line.length() == 0) {
                     continue;
                 }
 
                 addGroup(line);
             }
         } finally {
             if (reader != null) {
                 try {
                     reader.close();
                 } catch (Exception e) {
                 }
             }
         }
     }
 
     public void addGroups(String[] groupClasses) throws Exception {
         if (groupClasses == null) {
             return;
         }
 
         for (String groupClass : groupClasses) {
             addGroup(groupClass);
         }
     }
 
     public void addGroup(String groupClass) throws Exception {
         if (groupClass == null) {
             return;
         }
 
         groupClass = groupClass.trim();
         if (groupClass.length() == 0) {
             return;
         }
 
         Class<?> clazz = ClassLoaderUtil.loadClass(groupClass);
         Object o = clazz.newInstance();
         CmisTestGroup group = null;
 
         if (o instanceof CmisTestGroup) {
             group = (CmisTestGroup) o;
         } else if (o instanceof CmisTest) {
             group = new WrapperCmisTestGroup((CmisTest) o);
         } else {
             throw new Exception("Not a CmisTestGroup or CmisTest class!");
         }
 
         addGroup(group);
     }
 
     public void addGroup(CmisTestGroup group) throws Exception {
         if (group != null) {
             group.init(parameters);
             groups.add(group);
         }
     }
 
     public List<CmisTestGroup> getGroups() {
         return groups;
     }
 
     // --- run ---
 
     /**
      * Runs all configured groups.
      */
     public void run(CmisTestProgressMonitor monitor) throws Exception {
         isCanceled = false;
 
         for (CmisTestGroup group : groups) {
             synchronized (this) {
                 if (isCanceled) {
                     break;
                 }
             }
 
             if (group == null || !group.isEnabled()) {
                 continue;
             }
 
             group.setProgressMonitor(monitor);
             group.run();
         }
     }
 
     public synchronized boolean isCanceled() {
         return isCanceled;
     }
 
     public synchronized void cancel() {
         isCanceled = true;
     }
 }