/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2016 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package com.sun.codemodel;
import java.io.CharArrayWriter;
import java.io.PrintWriter;
import java.util.regex.Pattern;
import org.junit.After;
import org.junit.Test;
import static org.junit.Assert.*;
import org.junit.Before;
/**
* Test Java module.
* @author Tomas Kraus
*/
public class JModuleTest {
/** Java package name used in tests. */
static final String PKG_NAME = "jaxb.package";
/** Java module name used in tests. */
static final String MODULE_NAME = "jaxb.test";
/** Dependent Java module name used in tests. */
static final String DEP_MODULE_NAME = "other.module";
/** System dependent new line. */
static final String EOL = System.getProperty("line.separator");
/** Pattern to match white spaces sequences. */
private static final Pattern WH_SPACES = Pattern.compile("\\p{javaWhitespace}+");
/** Character array writer used to verify code generation output. */
protected CharArrayWriter out;
/** Java formatter used to generate code output. */
protected JFormatter jf;
/**
* Normalize white space sequences for {@code String} verification.
* @param str Source {@code String}.
* @return Source {@code String} with all whitespace sequences normalized.
*/
static String normalizeWhiteSpaces(final String str) {
if (str == null) {
return str;
}
return WH_SPACES.matcher(str).replaceAll(" ");
}
/**
* Creates an instance of Java module test.
*/
public JModuleTest() {
}
/**
* Initialize test.
*/
@Before
public void setUp() {
openOutput();
}
/**
* Cleanup test.
*/
@After
public void tearDown() {
closeOutput();
}
/**
* Open Java formatting output for this test.
*/
protected void openOutput() {
out = new CharArrayWriter();
jf = new JFormatter(new PrintWriter(out));
}
/**
* Close Java formatting output for this test.
*/
protected void closeOutput() {
jf.close();
out.close();
}
/**
* Reopen Java formatting output for this test.
* Used to reset output content during tests.
*/
protected void reopenOutput() {
closeOutput();
openOutput();
}
/**
* Test of name method, of class JModule.
*/
@Test
public void testName() {
final JModule instance = new JModule(MODULE_NAME);
assertEquals(MODULE_NAME, instance.name());
}
/**
* Check that module directives set contains exactly one element.
* @param instance Java module instance being checked.
* @return Directive element stored in the set.
*/
private static JModuleDirective directivesSingleElementCheck(final JModule instance) {
final JModuleDirective[] directives = instance.getDirectives().toArray(new JModuleDirective[1]);
assertNotNull(directives);
assertEquals(1, directives.length);
return directives[0];
}
/**
* Test of _exports method, of class JModule.
* {@code JModule} instance must contain exactly one directive instance
* of {@code JExportsDirective} class after {@code _exports} method call.
*/
@Test
public void test_exports() {
final JModule instance = new JModule(MODULE_NAME);
final JCodeModel cm = new JCodeModel();
final JPackage pkg = new JPackage(PKG_NAME, cm);
instance._exports(pkg);
JModuleDirective directive = directivesSingleElementCheck(instance);
assertTrue(directive instanceof JExportsDirective);
assertEquals(PKG_NAME, directive.name);
}
/**
* Test of _requiresModule method, of class JModule.
*/
@Test
public void test_requires() {
final JModule instance = new JModule(MODULE_NAME);
instance._requires(DEP_MODULE_NAME);
JModuleDirective directive = directivesSingleElementCheck(instance);
assertTrue(directive instanceof JRequiresDirective);
assertEquals(DEP_MODULE_NAME, directive.name);
}
/**
* Test of generate method, of class JModule.
*/
@Test
public void testGenerate() {
final JModule instance = new JModule(MODULE_NAME);
instance.generate(jf);
final String output = normalizeWhiteSpaces(out.toString());
//System.out.println("OUT: \""+output+"\"");
verifyModuleEnvelope(output, instance);
}
/**
* Verify generated module envelope.
*/
private static void verifyModuleEnvelope(final String output, final JModule instance) {
final int len = 14 + instance.name().length();
final StringBuilder sb = new StringBuilder(len);
sb.append("module ");
sb.append(instance.name());
sb.append(' ');
sb.append('{').append(EOL);
sb.append('}').append(EOL);
//System.out.println("verifyModuleEnvelope LEN: " + sb.length() + " - " + len);
final String check = normalizeWhiteSpaces(sb.toString());
assertEquals(check, output);
}
}