GWT Open Source Project
rluble Adds helpers to Serializable for J2CL.
Change-Id: I6931a2ef62e8e7c0939bb7da3f31f1655fb5067f
Latest commit 554e25d Oct 15, 2018
Permalink
Failed to load latest commit information.
.github Add Github Issue/Pull request templates and contributing.md Jan 22, 2017
build_tools Update list of emulated packages in emul ref generator Oct 20, 2017
dev-ext Merging releases/1.6@4385:4459 into trunk. Jan 16, 2009
dev Adds helpers to Serializable for J2CL. Oct 15, 2018
distro-source Add `when-linker-added` element definition Jun 18, 2018
doc Disable doclint when generating javadoc with Java 8 Feb 10, 2017
eclipse Update ASM to 6.1.1 in Maven POMs for -sourceLevel 10 support Apr 29, 2018
elemental Explicitly throw JsonException for unparseable input + some tests Apr 18, 2017
maven Update ASM to 6.1.1 in Maven POMs for -sourceLevel 10 support Apr 29, 2018
requestfactory Adding missing Ant properties when disabling tests Feb 17, 2016
samples Increase Java heap for buliding samples. Dec 14, 2017
servlet Fix packaging and Maven dependencies after sourcemaps update Jun 28, 2016
tools Update CLDR to version 32.0.1 Mar 11, 2018
user Adds helpers to Serializable for J2CL. Oct 15, 2018
.gitignore Add note about global gitignore in our .gitignore files. Oct 12, 2014
CONTRIBUTING.md Add Github Issue/Pull request templates and contributing.md Jan 22, 2017
README.md Fix 'GWT' headline not being rendered properly Feb 6, 2018
WORKSPACE Add bazel rules that can be used by J2CL for building the jre. Aug 11, 2017
build.xml Remove outdated jni/ folder. Sep 22, 2017
common.ant.xml Compile using Error Prone (when using Java 8) May 9, 2017
platforms.ant.xml Checkstyle update to 5.7 and style fixes. Mar 19, 2014

README.md

GWT

nightly gitter irc

GWT is the official open source project for GWT releases 2.5 and onwards.

In this document you have some quick instructions to build the SDK from source code and to run its tests.

For a more detailed documentation visit our web site. If you are interested in contributing with the project, please read the Making GWT better section.

Building the GWT SDK:

  • In order to build GWT, java and ant are required in your system.

  • Optional: if you want to compile elemental you need python and g++ installed.

  • You need the GWT tools repository checked out and up-to-date. By default it is expected to be found at ../tools. You can override the default location using the GWT_TOOLS environment variable or passing -Dgwt.tools= argument to ant.

  • To create the SDK distribution files run:

    $ ant clean elemental dist-dev

    or if you don't have python and g++ just run

    $ ant clean dist-dev

    Then you will get all .jar files in the folder build/lib and the redistributable file will be: build/dist/gwt-0.0.0.zip

    if you want to specify a different version number run:

    $ ant clean elemental dist-dev -Dgwt.version=x.x.x

  • To compile everything including examples you have to run

    $ ant clean elemental dist

How to verify GWT code conventions:

  • In GWT we have some conventions so as all code written by contributors look similar being easier to review.

  • After you make any modification, run this command to compile everything including tests, to check APIs, and to verify code style. It shouldn't take longer than 3-4 minutes.

    `$ ant compile.tests apicheck checkstyle

How to run GWT tests

  • Previously to run any test you have to set some environment variables to guarantee that they are run in the same conditions for all developers.

    In a Unix like platform you can use the export command:

    $ export TZ=America/Los_Angeles ANT_OPTS=-Dfile.encoding=UTF-8

    But in Windows™ you have to set the time-zone in your control panel, and the environment variables using the command set.

  • Finally you can run all test suites with the following command, but be prepared because it could take hours, and probably it would fail because of timeouts, etc.

    $ ant test

  • Thus, you might want to run only certain tests so as you can focus on checking the modifications you are working on.

    GWT build scripts use specific ant tasks and a bunch of system properties listed in the following table to specify which tests to run and how.

    For instance to run the task test in the module user you have to change to the user folder and run ant with the task as argument, adding any other property with the -D flag:

    $ ( cd user && ant test -Dtest.emma.htmlunit.disable=true ; cd .. )

    Module Task Property to skip Description
    dev test test.dev.disable GWT compiler & dev libraries
    codeserver test test.codeserver.disable SuperDevMode server
    user test test.user.disable GWT user API and JRE emulation
    user test.nongwt test.nongwt.disable Run tests that not require GWTTestCase
    user test.dev.htmlunit test.dev.htmlunit.disable Run dev-mode tests with HtmlUnit
    user test.web.htmlunit test.web.htmlunit.disable Run web-mode tests with HtmlUnit
    user test.draft.htmlunit test.draft.htmlunit.disable Run draft compiled HtmlUnit tests
    user test.nometa.htmlunit test.nometa.htmlunit.disable Run -XdisableClassMetadata tests with HtmlUnit
    user test.emma.htmlunit test.emma.htmlunit.disable Run emma tests with HtmlUnit
    user test.coverage.htmlunit test.coverage.htmlunit.disable Run tests for coverage support
    user test.dev.selenium test.dev.selenium.disable Run dev-mode tests using Selenium RC servers
    user test.web.selenium test.web.selenium.disable Run web tests using Selenium RC servers
    user test.draft.selenium test.draft.selenium.disable Run draft compiled tests using Selenium RC servers
    user test.nometa.selenium test.nometa.selenium.disable Run -XdisableClassMetadata tests using Selenium RC servers
    user test.emma.selenium test.emma.selenium.disable Run emma tests with Selenium RC servers
    requestfactory test test.requestfactory.disable Request Factory library
    elemental test test.elemental.disable Elemental library
    elemental test.nongwt test.nongwt.disable Run elemental tests that not require GWTTestCase
    elemental test.dev.htmlunit test.dev.htmlunit.disable Run elemental dev-mode tests with HtmlUnit
    elemental test.web.htmlunit test.web.htmlunit.disable Run elemental web-mode tests with HtmlUnit
    tools test test.tools.disable Some tools used in GWT development

    Additionally you can utilize some variables to filter which test to run in each task:

    Module Task Properties Default
    dev/core test gwt.junit.testcase.dev.core.includes **/com/google/**/*Test.class
                |                                       | gwt.junit.testcase.dev.core.excludes |
    

    user | test | gwt.junit.testcase.includes | **/*Suite.class user | test.nongwt | gwt.nongwt.testcase.includes | **/*JreSuite.class | | gwt.nongwt.testcase.excludes | user | test.web.* test.draft.* test.nometa.* | gwt.junit.testcase.web.includes | **/*Suite.class | | gwt.junit.testcase.web.excludes | **/*JsInteropSuite.class,**/*JreSuite.class,***/OptimizedOnly* user | test.dev.* test.emma.* | gwt.junit.testcase.dev.includes | **/*Suite.class | | gwt.junit.testcase.dev.excludes | **/*JsInteropSuite.class,**/*JreSuite.class,***/OptimizedOnly*

Examples

  • Run all tests in dev

    $ ( cd dev && ant test ; cd .. )

    Note: that the last `cd ..' is only needed in Windows.

  • There is another option to do the same but without changing to the module folder. We have to specify the module as the ant task, and the task as a target argument.

    $ ant dev -Dtarget=test

  • Run all tests in codeserver

    $ ( cd dev/codeserver && ant test )

    or

    $ ant codeserver -Dtarget=test -Dtest.dev.disable=true

    Note: that we disable dev tests because code server depends on dev and we don`t want to run its tests.

  • Run all tests in elemental:

    $ ( cd elemental && ant test.nongwt )

    or

    $ ant elemental -Dtarget=test -Dtest.dev.disable=true -Dtest.user.disable=true

    Note: that we have to disable dev and user tests because elemental depends on both.

  • Run all tests in tools

    $ ant tools -Dtarget=test -Dtest.dev.disable=true -Dtest.user.disable=true

  • Run only the JsniRefTest in dev

    $ ant dev -Dtarget=test \
        -Dgwt.junit.testcase.dev.core.includes="**/JsniRefTest.class"
    
  • Run a couple of tests in dev

    $ ant dev -Dtarget=test \
        -Dgwt.junit.testcase.dev.core.includes="**/JsniRefTest.class,**/JsParserTest.class"
    

    Note: that you have to use regular expressions separated by comma to select the test classes to execute.

  • Run all Jre tests in user, they should take not longer than 3min. We have two ways to run them. Although the second case is more complex it is here to know how disable properties work.

    $ ( cd user && ant test.nongwt )

    or

    $ ant user -Dtarget=test
           -Dtest.dev.disable=true \
           -Dtest.codeserver.disable=true \
           -Dtest.requestfactory.disable=true \
           -Dtest.elemental.disable=true \
           -Dtest.tools.disable=true \
           -Dtest.dev.htmlunit.disable=true \
           -Dtest.web.htmlunit.disable=true \
           -Dtest.coverage.htmlunit.disable=true \
           -Dtest.dev.selenium.disable=true \
           -Dtest.draft.htmlunit.disable=true \
           -Dtest.draft.selenium.disable=true \
           -Dtest.emma.htmlunit.disable=true \
           -Dtest.emma.selenium.disable=true \
           -Dtest.nometa.htmlunit.disable=true \
           -Dtest.nometa.selenium.disable=true \
           -Dtest.web.selenium.disable=true
    

    Note: that we have to set all disable variables but test.nongwt.disable

  • Run certain Jre tests in the user module.

    $ ( cd user && ant test.nongwt -Dgwt.nongwt.testcase.includes="**/I18NJreSuite.class" )

  • Run all GWT tests in user using htmlunit in dev mode.

    $ ( cd user && ant test.dev.htmlunit )