TemplateControllerSignatureUsageTest.java

/*
 * ******************************************************************************
 * MontiCore Language Workbench
 * Copyright (c) 2015, MontiCore, All rights reserved.
 *
 * This project is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3.0 of the License, or (at your option) any later version.
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this project. If not, see <http://www.gnu.org/licenses/>.
 * ******************************************************************************
 */

package de.monticore.generating.templateengine;

import com.google.common.collect.Lists;

import de.monticore.generating.templateengine.freemarker.FreeMarkerConfigurationBuilder;
import de.monticore.generating.templateengine.freemarker.FreeMarkerTemplateEngine;
import de.monticore.generating.templateengine.freemarker.MontiCoreFreeMarkerException;
import de.monticore.io.FileReaderWriterMock;

import org.junit.Before;
import org.junit.Ignore;
import org.junit.Test;

import java.io.File;
import java.util.ArrayList;

import static de.monticore.generating.templateengine.TestConstants.TEMPLATE_PACKAGE;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertTrue;
import static org.junit.Assert.fail;

/**
 * Tests for parameterized calls of the {@link TemplateController} 
 *
 * @author  Pedram Nazari
 *
 */
public class TemplateControllerSignatureUsageTest {
  
  private TemplateControllerMock tc;
  private GlobalExtensionManagement glex;
  
  @Before
  public void setup() {
    glex = new GlobalExtensionManagement();
    
    FreeMarkerTemplateEngine freeMarkerTemplateEngine = new FreeMarkerTemplateEngine(new FreeMarkerConfigurationBuilder().build());
    
    TemplateControllerConfiguration config = new TemplateControllerConfigurationBuilder()
                                                .glex(glex)
                                                .freeMarkerTemplateEngine(freeMarkerTemplateEngine)
                                                .fileHandler(new FileReaderWriterMock())
                                                .classLoader(getClass().getClassLoader())
                                                .externalTemplatePaths(new File[]{})
                                                .outputDirectory(new File("dummy"))
                                                .tracing(false)
                                                .build();
    
    tc = new TemplateControllerMock(config, "");
  }
  
  @Test
  public void testSignatureMethodInvokedSeveralTimes() {
    tc.signature();
    assertTrue(tc.isSignatureInitialized());
    
    try {
      tc.signature();
      fail("An exception is expected here, because signature() is called more than once.");
    }
    catch (IllegalArgumentException e) {
      // everything's fine
    }
  }
  
  
  
  // =================================================
  // Tests with templates
  // =================================================
  
  @Test
  public void testSignatureWithOneParameter() {
    String output = tc.includeArgs(TEMPLATE_PACKAGE + "SignatureWithOneParameter", Lists.<Object>newArrayList("Charly"));
    
    TemplateController tcChild = tc.getSubController();
    assertNotNull(tcChild);
    assertTrue(tcChild.isSignatureInitialized());
    
    assertEquals(1, tcChild.getSignature().size());
    assertEquals("name", tcChild.getSignature().get(0));
    
    assertEquals(1, tcChild.getArguments().size());
    assertEquals("Charly", tcChild.getArguments().get(0));
    
    assertEquals("Name is Charly", output);
  }
  
  @Test
  public void testSignatureWithThreeParameters() {
    String output = tc.includeArgs(TEMPLATE_PACKAGE + "SignatureWithThreeParameters", 
        Lists.<Object>newArrayList("Charly", "30", "Aachen"));
    
    TemplateController tcChild = tc.getSubController();
    assertNotNull(tcChild);
    assertTrue(tcChild.isSignatureInitialized());
    
    assertEquals(3, tcChild.getSignature().size());
    assertEquals("name", tcChild.getSignature().get(0));
    assertEquals("age", tcChild.getSignature().get(1));
    assertEquals("city", tcChild.getSignature().get(2));
    
    assertEquals(3, tcChild.getArguments().size());
    assertEquals("Charly", tcChild.getArguments().get(0));
    assertEquals("30", tcChild.getArguments().get(1));
    assertEquals("Aachen", tcChild.getArguments().get(2));
    
    assertEquals("Name is Charly, age is 30, city is Aachen", output);
  }
  
  @Test
  public void testSignatureWithManyParameters() {
    String output = tc.includeArgs(TEMPLATE_PACKAGE + "SignatureWithManyParameters", 
        Lists.<Object>newArrayList("Charly", "30", "Aachen", "52062", "Engineer", "No friends"));
    
    TemplateController tcChild = tc.getSubController();
    assertNotNull(tcChild);
    assertTrue(tcChild.isSignatureInitialized());
    
    assertEquals(6, tcChild.getSignature().size());
    assertEquals("name", tcChild.getSignature().get(0));
    assertEquals("age", tcChild.getSignature().get(1));
    assertEquals("city", tcChild.getSignature().get(2));
    assertEquals("zip", tcChild.getSignature().get(3));
    assertEquals("job", tcChild.getSignature().get(4));
    assertEquals("friends", tcChild.getSignature().get(5));
    
    assertEquals(6, tcChild.getArguments().size());
    assertEquals("Charly", tcChild.getArguments().get(0));
    assertEquals("30", tcChild.getArguments().get(1));
    assertEquals("Aachen", tcChild.getArguments().get(2));
    assertEquals("52062", tcChild.getArguments().get(3));
    assertEquals("Engineer", tcChild.getArguments().get(4));
    assertEquals("No friends", tcChild.getArguments().get(5));
    
    assertEquals("Name=Charly, age=30, city=Aachen, zip=52062, job=Engineer, friends=No friends", output);
  }
  
  @Test
  public void testNestedSignatureCalls() {
    String output = tc.includeArgs(TEMPLATE_PACKAGE + "NestedSignatureCalls", 
        Lists.<Object>newArrayList("T1"));
    
    assertEquals("T1 -> Name is T2", output);
  }
    
  
  @Test
  public void testWrongNumberOfArguments() {
    try {
      tc.includeArgs(TEMPLATE_PACKAGE + "SignatureWithOneParameter",
          Lists.<Object>newArrayList("Charly", "tooMuch"));
      fail("Argument list is too long.");
    }
    catch(MontiCoreFreeMarkerException e) {
      assertTrue(e.getCause() instanceof IllegalArgumentException);
    }
  }
  
  @Test
  public void testArgumentsAreOnlyVisibleInIncludedTemplate() {
    String templateOutput = tc.includeArgs(TEMPLATE_PACKAGE + "ArgumentsAreOnlyVisibleInIncludedTemplate",
        Lists.<Object>newArrayList("Charly"));
    
    assertEquals("Hello Charly\nSorry, what was your name?", templateOutput);
  }
    
  @Test
  public void testParameterizedInclusionUsage() {
    String templateOutput = tc.include(TEMPLATE_PACKAGE + "ParameterizedInclusionUsage");
    
    assertEquals(
        "Name is Charly\n" +
        "Name is Charly, age is 30, city is Aachen\n" +
        "Name=Charly, age=30, city=Aachen, zip=52062, job=Engineer, friends=No friends"
        , templateOutput);
  }
}