This page describes the jobs that are automatically available to all skeleton-based applications (particularly, applications with config.json files that include the framework's application.json config file). Mainly this is just a reference list with short descriptions of what the jobs do. But in some cases, there is comprehensive documentation about the interface of this job and how it can be parametrized (This would usually require changing your config.json configuration file).
These jobs can be invoked with the generator, e.g. as generate.py <jobname>.
Create api doc for the current library. Use the following macros to tailor the scope of classes that are going to show up in the customized apiviewer application:
"API_INCLUDE" = ["<class_patt1>", "<class_patt2>", ...]
"API_EXCLUDE" = ["<class_patt1>", "<class_patt2>", ...]
The syntax for the class pattern is like those for the include config key.
Create the api data for the current library. This is included in the api job, but allows you to re-generate the api data .json files for the classes without re-generating the Apiviewer application as well. Moreover, you can supply class names as command line arguments to only re-generate the api data for those:
sh> generate.py api-data my.own.ClassA ...
Beware though that in such a case the tree information provided to the Apiviewer (i.e. what you see in the Apiviewer's tree view on the left) is also restricted to those classes (augmented by stubs for their ancestors for hierarchy resolution). But this should be fine for developing API documenation for specific classes.
Create build version of current application.
Remove local cache and generated .js files (source/build).
Remove the cache and all generated artefacts of this library (source, build, ...).
Normalize whitespace in .js files of the current library (tabs, eol, ...).
Running this job will print out various information about your setup on the console. Information includes your qooxdoo and Python version, whether source and/or build version of your app has been built, stats on the cache, asf.
Create an instance of the Inspector in the current application. The inspector is a debugging tool that allows you to inspect your custom application while running. You need to run the source job first, the run the inspector job. You will then be able to open the file source/inspector.html in your browser. The source version of your application will be loaded into the inspector automatically.
Check the source code of the .js files of the current library.
Migrate the .js files of the current library to the current qooxdoo version.
Here is a sample run of the migration job:
./generate.py migration
NOTE: To apply only the necessary changes to your project, we
need to know the qooxdoo version it currently works with.
Please enter your current qooxdoo version [1.0] :
Enter your qooxdoo version or just hit return if you are using the version given in square brackets.
MIGRATION SUMMARY:
Current qooxdoo version: 1.0
Upgrade path: 1.0.1 -> 1.1 -> 1.2
Affected Classes:
feedreader.view.Header
feedreader.view.Article
feedreader.view.Tree
feedreader.PreferenceWindow
feedreader.view.ToolBar
feedreader.FeedParser
feedreader.view.Table
feedreader.Application
feedreader.test.DemoTest
NOTE: It is advised to do a 'generate.py distclean' before migrating any files.
If you choose 'yes', a subprocess will be invoked to run distclean,
and after completion you will be prompted if you want to
continue with the migration. If you choose 'no', the distclean
step will be skipped (which might result in potentially unnecessary
files being migrated).
Do you want to run 'distclean' now? [yes] :
Enter "yes".
WARNING: The migration process will update the files in place. Please make
sure, you have a backup of your project. The complete output of the
migration process will be logged to 'migration.log'.
Do you want to start the migration now? [no] :
Enter "yes".
Check migration.log for messages that contain foo.js has been modified. Storing modifications ... to verify changes to class code.
Creates a runner application (the Simulator (Experimental)) for Selenium-based GUI interaction tests of the current library.
The Simulator is configured using the "settings" key of this job. The following settings are supported:
Starts Rhino and executes a Simulator (Experimental) test application generated by simulation-build.
Configured using the "simulate" key.
Pretty-formatting of the source code of the current library.
Create source version of current application.
Create source version of current application, with all classes.
Create a test runner app for unit tests of the current library.
Use the following macro to tailor the scope of classes in which unit test classes are searched for:
"TEST_INCLUDE" = ["<class_patt1>", "<class_patt2>", ...]
The syntax for the class pattern is like those for the include config key.
The libraries from the libraries job will be included when building the test application (the application containing your unit tests is a separate application which is loaded into the runner application).
If you want to break out from the reliance on the libraries job altogether, or have very specific settings that must be applied to the test application, you can provide a custom includer job common-tests which may contain a custom library key and other keys. But then you have to make sure it contains the Testrunner library as well.
"common-tests" :
{
"extend" : [ "libraries" ],
"let" : { "LOCALES" : ["de", "de_DE", "fr", "fr_FR" ] },
"library" :
[
{ "manifest" : "${QOOXDOO_PATH}/framework/Manifest.json" },
{ "manifest" : "${TESTRUNNER_ROOT}/Manifest.json" }
],
"include" : ["testrunner.TestLoader", "${TEST_INCLUDE}", "${QXTHEME}"],
"settings" :
{
"qx.theme" : "${QXTHEME}",
"qx.globalErrorHandling" : "on"
},
"cache" :
{
"compile" : "${CACHE}"
}
}
This allows you to tailor most of the parameters that influence the creation of the test application.
Create a test runner app for unit tests (source version) of the current library.
The same customization interface applies as for the default test job.
Create an inline test runner app for unit tests of the current library.
The same customization interface applies as for the default test job.
Create a native test runner app for unit tests of the current library.
The same customization interface applies as for the default test job.
Create .po files for current library.
These jobs don't do anything sensible on their own, so it is no use to invoke them with the generator. But they can be used in the application's config.json, to modify the behaviour of other jobs, as they pick up their definitions.
Common includer job for many default jobs, mostly used internally. You should usually not need to use it; if you do, use with care.
This job should take a single key, library. The libraries job is filled by default with your application and the qooxdoo framework library, plus any additional libraries you specify in a custom libraries job you added to your application's config.json. Here, you can add additional libraries and/or contributions you want to use in your application. See the linked reference for more information on the library key. Various other jobs will evaluate the libraries job (like api, test), to work on a common set of libraries.
"libraries" :
{
"library" : [ { "manifest" : "some/other/lib/Manifest.json" }]
}
Includer job, to activate profiling.
Includer job, to activate verbose logging of part generation; use with the -v command line switch.
Includer job, to activate verbose logging of class dependencies; use with the -v command line switch.