Issue224.java

/*
 * $Id$
 *
 * Janus platform is an open-source multiagent platform.
 * More details on http://www.janusproject.io
 *
 * Copyright (C) 2014-2015 Sebastian RODRIGUEZ, Nicolas GAUD, Stéphane GALLAND.
 *
 * 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 io.janusproject.tests.bugs;

import java.util.Collection;
import java.util.UUID;
import java.util.concurrent.atomic.AtomicInteger;

import org.junit.Test;

import io.janusproject.kernel.services.jdk.contextspace.Context.DefaultSpaceRepositoryFactory;
import io.janusproject.tests.testutils.AbstractJanusRunTest;

import io.sarl.core.Behaviors;
import io.sarl.core.DefaultContextInteractions;
import io.sarl.core.Destroy;
import io.sarl.core.Initialize;
import io.sarl.core.InnerContextAccess;
import io.sarl.core.Lifecycle;
import io.sarl.core.Schedules;
import io.sarl.lang.SARLVersion;
import io.sarl.lang.annotation.PerceptGuardEvaluator;
import io.sarl.lang.annotation.SarlSpecification;
import io.sarl.lang.core.Agent;
import io.sarl.lang.core.Behavior;
import io.sarl.lang.core.BuiltinCapacitiesProvider;
import io.sarl.lang.core.Event;

/**
 * Unit test for the issue #224: Equivalent of Skill.install for the Behavior class.
 * 
 * @author $Author: sgalland$
 * @version $FullVersion$
 * @mavengroupid $GroupId$
 * @mavenartifactid $ArtifactId$
 * @see https://github.com/sarl/sarl/issues/224
 */
@SuppressWarnings("all")
public class Issue224 extends AbstractJanusRunTest {

	private static final int TIMEOUT = 1000;

	@Test
	public void registerInInitialize() throws Exception {
		runJanus(RegisteredInInitializeAgent.class, false);
		assertEquals(1, getNumberOfResults());
		RegisteredInInitializeAgent agent = getResult(RegisteredInInitializeAgent.class, 0);
		assertEquals(1, agent.behavior.initializeEvaluations.intValue());
		assertEquals(1, agent.behavior.destroyEvaluations.intValue());
	}

	@Test
	public void registerInHandler() throws Exception {
		runJanus(RegisteredInHandlerAgent.class, false);
		assertEquals(1, getNumberOfResults());
		RegisteredInHandlerAgent agent = getResult(RegisteredInHandlerAgent.class, 0);
		assertEquals(1, agent.behavior.initializeEvaluations.intValue());
		assertEquals(1, agent.behavior.destroyEvaluations.intValue());
	}

	@Test
	public void registerInDestroy() throws Exception {
		runJanus(RegisteredInDestroyAgent.class, false);
		assertEquals(1, getNumberOfResults());
		RegisteredInDestroyAgent agent = getResult(RegisteredInDestroyAgent.class, 0);
		assertEquals(0, agent.behavior.initializeEvaluations.intValue());
		assertEquals(0, agent.behavior.destroyEvaluations.intValue());
	}

	@Test
	public void unregisterInInitialize() throws Exception {
		runJanus(UnregisteredInInitializeAgent.class, false);
		assertEquals(1, getNumberOfResults());
		UnregisteredInInitializeAgent agent = getResult(UnregisteredInInitializeAgent.class, 0);
		assertEquals(1, agent.behavior.initializeEvaluations.intValue());
		assertEquals(1, agent.behavior.destroyEvaluations.intValue());
	}

	@Test
	public void unregisterInHandler() throws Exception {
		runJanus(UnregisteredInHandlerAgent.class, false);
		assertEquals(1, getNumberOfResults());
		UnregisteredInHandlerAgent agent = getResult(UnregisteredInHandlerAgent.class, 0);
		assertEquals(1, agent.behavior.initializeEvaluations.intValue());
		assertEquals(1, agent.behavior.destroyEvaluations.intValue());
	}

	@Test
	public void unregisterInDestroy() throws Exception {
		runJanus(UnregisteredInDestroyAgent.class, false);
		assertEquals(1, getNumberOfResults());
		UnregisteredInDestroyAgent agent = getResult(UnregisteredInDestroyAgent.class, 0);
		assertEquals(0, agent.behavior.initializeEvaluations.intValue());
		assertEquals(0, agent.behavior.destroyEvaluations.intValue());
	}

	@SarlSpecification(SARLVersion.SPECIFICATION_RELEASE_VERSION_STRING)
	public static class MyBehavior extends Behavior {

		public final AtomicInteger initializeEvaluations = new AtomicInteger();

		public final AtomicInteger destroyEvaluations = new AtomicInteger();

		public MyBehavior(Agent owner) {
			super(owner);
		}

		@PerceptGuardEvaluator
		private void onInitializeGuard(Initialize event, Collection<Runnable> handlers) {
			this.initializeEvaluations.incrementAndGet();
		}

		@PerceptGuardEvaluator
		private void onDestroyGuard(Destroy event, Collection<Runnable> handlers) {
			this.destroyEvaluations.incrementAndGet();
		}

	}

	@SarlSpecification(SARLVersion.SPECIFICATION_RELEASE_VERSION_STRING)
	public static class MyEvent extends Event {
		//
	}

	@SarlSpecification(SARLVersion.SPECIFICATION_RELEASE_VERSION_STRING)
	public static class RegisteredInInitializeAgent extends TestingAgent {

		public MyBehavior behavior = new MyBehavior(this);


		public RegisteredInInitializeAgent(BuiltinCapacitiesProvider provider, UUID parentID, UUID agentID) {
			super(provider, parentID, agentID);
		}

		@Override
		protected boolean runAgentTest() {
			addResult(this);
			getSkill(Behaviors.class).registerBehavior(this.behavior);
			getSkill(Schedules.class).in(TIMEOUT, (agent) -> getSkill(Lifecycle.class).killMe());
			return false;
		}

	}

	@SarlSpecification(SARLVersion.SPECIFICATION_RELEASE_VERSION_STRING)
	public static class RegisteredInHandlerAgent extends TestingAgent {

		public MyBehavior behavior = new MyBehavior(this);

		public RegisteredInHandlerAgent(BuiltinCapacitiesProvider provider, UUID parentID, UUID agentID) {
			super(provider, parentID, agentID);
		}

		@Override
		protected boolean runAgentTest() {
			addResult(this);
			getSkill(DefaultContextInteractions.class).emit(new MyEvent());
			getSkill(Schedules.class).in(TIMEOUT, (agent) -> getSkill(Lifecycle.class).killMe());
			return false;
		}

		@PerceptGuardEvaluator
		private void onMyEventGuard(MyEvent event, Collection<Runnable> handlers) {
			handlers.add(() -> onMyEvent(event, event));
		}

		private void onMyEvent(MyEvent occurrence, MyEvent it) {
			getSkill(Behaviors.class).registerBehavior(this.behavior);
		}

	}

	@SarlSpecification(SARLVersion.SPECIFICATION_RELEASE_VERSION_STRING)
	public static class RegisteredInDestroyAgent extends TestingAgent {

		public MyBehavior behavior = new MyBehavior(this);

		public RegisteredInDestroyAgent(BuiltinCapacitiesProvider provider, UUID parentID, UUID agentID) {
			super(provider, parentID, agentID);
		}

		@Override
		protected boolean runAgentTest() {
			addResult(this);
			return true;
		}

		@PerceptGuardEvaluator
		private void onDestroyGuard(Destroy event, Collection<Runnable> handlers) {
			handlers.add(() -> onDestroy(event, event));
		}

		private void onDestroy(Destroy occurrence, Destroy it) {
			getSkill(Behaviors.class).registerBehavior(this.behavior);
		}

	}

	@SarlSpecification(SARLVersion.SPECIFICATION_RELEASE_VERSION_STRING)
	public static class UnregisteredInInitializeAgent extends TestingAgent {

		public MyBehavior behavior = new MyBehavior(this);


		public UnregisteredInInitializeAgent(BuiltinCapacitiesProvider provider, UUID parentID, UUID agentID) {
			super(provider, parentID, agentID);
		}

		@Override
		protected boolean runAgentTest() {
			addResult(this);
			getSkill(Behaviors.class).registerBehavior(this.behavior);
			getSkill(Behaviors.class).unregisterBehavior(this.behavior);
			getSkill(Schedules.class).in(TIMEOUT, (agent) -> getSkill(Lifecycle.class).killMe());
			return false;
		}

	}

	@SarlSpecification(SARLVersion.SPECIFICATION_RELEASE_VERSION_STRING)
	public static class UnregisteredInHandlerAgent extends TestingAgent {

		public MyBehavior behavior = new MyBehavior(this);

		public UnregisteredInHandlerAgent(BuiltinCapacitiesProvider provider, UUID parentID, UUID agentID) {
			super(provider, parentID, agentID);
		}

		@Override
		protected boolean runAgentTest() {
			addResult(this);
			getSkill(Behaviors.class).registerBehavior(this.behavior);
			getSkill(DefaultContextInteractions.class).emit(new MyEvent());
			getSkill(Schedules.class).in(TIMEOUT, (agent) -> getSkill(Lifecycle.class).killMe());
			return false;
		}

		@PerceptGuardEvaluator
		private void onMyEventGuard(MyEvent event, Collection<Runnable> handlers) {
			handlers.add(() -> onMyEvent(event, event));
		}

		private void onMyEvent(MyEvent occurrence, MyEvent it) {
			getSkill(Behaviors.class).unregisterBehavior(this.behavior);
		}

	}

	@SarlSpecification(SARLVersion.SPECIFICATION_RELEASE_VERSION_STRING)
	public static class UnregisteredInDestroyAgent extends TestingAgent {

		public MyBehavior behavior = new MyBehavior(this);

		public UnregisteredInDestroyAgent(BuiltinCapacitiesProvider provider, UUID parentID, UUID agentID) {
			super(provider, parentID, agentID);
		}

		@Override
		protected boolean runAgentTest() {
			addResult(this);
			return true;
		}

		@PerceptGuardEvaluator
		private void onDestroyGuard(Destroy event, Collection<Runnable> handlers) {
			handlers.add(() -> onDestroy(event, event));
		}

		private void onDestroy(Destroy occurrence, Destroy it) {
			getSkill(Behaviors.class).registerBehavior(this.behavior);
			getSkill(Behaviors.class).unregisterBehavior(this.behavior);
		}

	}

}