/*
 * JBoss, Home of Professional Open Source
 * Copyright 2011 Red Hat Inc. and/or its affiliates and other contributors
 * as indicated by the @authors tag. All rights reserved.
 * See the copyright.txt in the distribution for a
 * full listing of individual contributors.
 *
 * Licensed 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.jboss.arquillian.container.test.impl;

import java.lang.reflect.Method;
import java.util.logging.Logger;

import org.jboss.arquillian.container.spi.Container;
import org.jboss.arquillian.container.spi.client.deployment.Deployment;
import org.jboss.arquillian.container.test.api.OperateOnDeployment;
import org.jboss.arquillian.container.test.api.RunAsClient;
import org.jboss.arquillian.container.test.impl.client.protocol.local.LocalProtocol;
import org.jboss.arquillian.test.spi.TestClass;

/**
 * RunModeUtils
 *
 * @author <a href="mailto:aslak@redhat.com">Aslak Knutsen</a>
 * @version $Revision: $
 */
public final class RunModeUtils
{
   private static Logger log = Logger.getLogger(RunModeUtils.class.getName());

   private RunModeUtils() { }
   
   /**
    * Returns if the given test should run as client.
    * 
    * Verify @Deployment.testable vs @RunAsClient on Class or Method level 
    * 
    * @param deployment
    * @param testClass
    * @param testMethod
    * @return
    */
   public static boolean isRunAsClient(Deployment deployment, TestClass testClass, Method testMethod)
   {
      boolean runAsClient = true;
      if (deployment != null)
      {
         runAsClient = deployment.getDescription().testable() ? false : true;
         runAsClient = deployment.isDeployed() ? runAsClient : true;

         if (testMethod.isAnnotationPresent(RunAsClient.class))
         {
            runAsClient = true;
         }
         else if (testClass.isAnnotationPresent(RunAsClient.class))
         {
            runAsClient = true;
         }
      }
      return runAsClient;
   }

   /**
    * Returns if the given test should run as client and also checks for a confusing use case, when the test is not
    * intended to be run as a client test - in this case logs a warning. see: ARQ-1937
    *
    * @param deployment
    * @param testClass
    * @param testMethod
    * @return
    */
   public static boolean isRunAsClientAndCheck(Deployment deployment, TestClass testClass, Method testMethod)
   {
      boolean runAsClient = isRunAsClient(deployment, testClass, testMethod);

      if (runAsClient && deployment == null)
      {
         Method[] methods = testClass.getMethods(org.jboss.arquillian.container.test.api.Deployment.class);
         if (methods.length > 0)
         {
            if (!testMethod.isAnnotationPresent(RunAsClient.class) && !testClass.isAnnotationPresent(RunAsClient.class))
            {
               OperateOnDeployment onDeployment = testClass.getAnnotation(OperateOnDeployment.class);
               String deploymentName = onDeployment == null ? "_DEFAULT_" : onDeployment.value();

               for (Method m : methods)
               {
                  org.jboss.arquillian.container.test.api.Deployment deploymentAnnotation =
                      m.getAnnotation(org.jboss.arquillian.container.test.api.Deployment.class);

                  if (deploymentAnnotation.name().equals(deploymentName) && deploymentAnnotation.testable())
                  {
                     log.warning(
                         "The test method " + testClass.getJavaClass().getCanonicalName() + "#" + testMethod.getName()
                             + " will run on the client side,because the " + deploymentName + " deployment is not deployed."
                             + " Please deploy the deployment or mark the test as a client test");
                  }
               }
            }
         }
      }
      return runAsClient;
   }

   /**
    * Check if this Container DEFAULTs to the Local protocol. 
    * 
    * Hack to get around ARQ-391
    * 
    * @param container
    * @return true if DeployableContianer.getDefaultProtocol == Local
    */
   public static boolean isLocalContainer(Container container)
   {
      if(
            container == null || 
            container.getDeployableContainer() == null || 
            container.getDeployableContainer().getDefaultProtocol() == null)
      {
         return false;
      }
      if(LocalProtocol.NAME.equals(container.getDeployableContainer().getDefaultProtocol().getName()))
      {
         return true;
      }
      return false;
   }
}
