NetBeans Architecture Answers for NB JUnit module

General Information

Question (arch-what): What is this project good for?
Answer:

Module contains NetBeans extension to JUnit.

Question (arch-overall): Describe the overall architecture.
Answer:

Module contains NetBeans extension to JUnit. It provides classes and methods which allow one to verify performance, memory consumption, file output and other aspects of the IDE or applications built on the NetBeans Platform.

Question (arch-usecases): Describe the main use cases of the new API. Who will use it under what circumstances? What kind of code would typically need to be written to use the module?
Answer:

Tests typically extends NbTestCase.

Question (arch-time): What are the time estimates of the work?
Answer:

Done.

Question (arch-quality): How will the quality of your code be tested and how are future regressions going to be prevented?
Answer:

Used daily for testing of NetBeans. A few unite tests exists.

Question (arch-where): Where one can find sources for your module?
Answer:

The sources for the module are in the Apache Git repositories or in the GitHub repositories.

Project and platform dependencies

Question (dep-nb): What other NetBeans projects and modules does this one depend on?
Answer: org.netbeans.insane - The only module that this one is using is the insane library to find leaked objects after unsuccessful assertGC calls.
Question (dep-non-nb): What other projects outside NetBeans does this one depend on?
Answer:

JUnit.

Question (dep-platform): On which platforms does your module run? Does it run in the same way on each?
Answer:

Any.

Question (dep-jre): Which version of JRE do you need (1.2, 1.3, 1.4, etc.)?
Answer:

1.5

Question (dep-jrejdk): Do you require the JDK or is the JRE enough?
Answer:

JDK.

Deployment

Question (deploy-jar): Do you deploy just module JAR file(s) or other files as well?
Answer:

Module jar for wrapper library.
modules/ext/nbjunit.jar - classes which extends JUnit.
modules/ext/nbjunit-ide.jar - ProjectSupport helper class.


Question (deploy-nbm): Can you deploy an NBM via the Update Center?
Answer:

Yes.

Question (deploy-shared): Do you need to be installed in the shared location only, or in the user directory only, or can your module be installed anywhere?
Answer:

Anywhere.

Question (deploy-packages): Are packages of your module made inaccessible by not declaring them public?
Answer:

No.

Question (deploy-dependencies): What do other modules need to do to declare a dependency on this one, in addition to or instead of the normal module dependency declaration (e.g. tokens to require)?
Answer:

Nothing.

Compatibility with environment

Question (compat-i18n): Is your module correctly internationalized?
Answer:

Yes.

Question (compat-standards): Does the module implement or define any standards? Is the implementation exact or does it deviate somehow?
Answer:

No.

Question (compat-version): Can your module coexist with earlier and future versions of itself? Can you correctly read all old settings? Will future versions be able to read your current settings? Can you read or politely ignore settings stored by a future version?
Answer:

N/A.

Question (compat-deprecation): How the introduction of your project influences functionality provided by previous version of the product?
Answer:

N/A.

Access to resources

Question (resources-file): Does your module use java.io.File directly?
Answer:

Yes.

Question (resources-layer): Does your module provide own layer? Does it create any files or folders in it? What it is trying to communicate by that and with which components?
Answer:

Yes. It adds template and library.

Question (resources-read): Does your module read any resources from layers? For what purpose?
Answer:

No.

Question (resources-mask): Does your module mask/hide/override any resources provided by other modules in their layers?
Answer:

No.

Question (resources-preferences): Does your module uses preferences via Preferences API? Does your module use NbPreferences or or regular JDK Preferences ? Does it read, write or both ? Does it share preferences with other modules ? If so, then why ?
Answer:

By default the NbTestCase provides its own in-memory implementation of preferences. To suppress this behaviour one can use initialize own Preferences by accessing them in static initializer of the suite.

Lookup of components

Question (lookup-lookup): Does your module use org.openide.util.Lookup or any similar technology to find any components to communicate with? Which ones?
Answer:

No.

Question (lookup-register): Do you register anything into lookup for other code to find?
Answer:

No.

Question (lookup-remove): Do you remove entries of other modules from lookup?
Answer:

No.

Execution Environment

Question (exec-property): Is execution of your code influenced by any environment or Java system (System.getProperty) property? On a similar note, is there something interesting that you pass to java.util.logging.Logger? Or do you observe what others log?
Answer:

NetBeans extension to JUnit uses standard JUnit preferences file to store additional information required when using advanced features of NbJUnit. The junit.properties file is a standard property file, which is stored in user's home directory (as defined in user.home system property of JVM). Recognized properties by NbJUnit are the following: nbjunit.diff.impl - name of the java class implementing org.netbeans.junit.diff.Diff inteface. This class performs 'diff' between files. In NBJunit extension is available org.netbeans.junit.diff.SimpleDiff for simple comparision (this class decides only whether compared files are equal or not, it does not provide any additional information) and org.netbeans.junit.diff.NativeDiff for comparision via native diff code (e.g. diff program on unix machines). Please note, SimpleDiff is rather trivial implementation of diff command, so it is recommended to use native diff whenever possible.

• nbjunit.diff.impl.CmdLine - used only when nbjunit.diff.impl is set to org.netbeans.junit.diff.NativeDiff class. This property contain command line, which is called from NativeDiff class to perform comparision. This property use also '%TESTFILE%' and '%PASSFILE%' variables understood by NbJUnit, which are replaced with real file names when running tests.
• nbjunit.workdir - path to a directory, which is used as a root for tests' working directories (for details see JavaDoc for NbTestCase.getWorkDir()).
• NbTestCase.order - This property tries to influence the order of NbTestCase methods so it is more predicatable (see Order of elements for description of the problem). The acceptable values of the property are:
  • "natural" - use the methods as provided by JDK (e.g. quite random on JDK7)
  • "a-z" - sort the tests in ascending alphabetical order
  • "z-a" - sort the tests in descending alphabetical order
  • "shuffle" - randomize the order of the tests. If a test fails in this mode a seed is attached to the failure message, use it in the seed mode
  • seed mode "12234390434" - one can specify any long value as a seed to shuffle the methods. Use this to reproduce random failures
  The default order is natural right now, but this may change in future to mitigate the randomness caused by JDK7.
• branding.token - NbModuleSuite can now be influenced by system property branding.token. If it is provided (by Ant harness for example), it is used to call NbBundle.setBranding.

s Here's an example of junit.properties file:

nbjunit.workdir=/space/netbeans/tests/workdir
nbjunit.diff.impl=org.netbeans.junit.diff.NativeDiff
nbjunit.diff.impl.CmdLine=/usr/bin/diff -bw %TESTFILE% %PASSFILE%

Question (exec-component): Is execution of your code influenced by any (string) property of any of your components?
Answer:

No.

Question (exec-ant-tasks): Do you define or register any ant tasks that other can use?
Answer:

No.

Question (exec-classloader): Does your code create its own class loader(s)?
Answer:

No.

Question (exec-reflection): Does your code use Java Reflection to execute other code?
Answer:

No.

Question (exec-privateaccess): Are you aware of any other parts of the system calling some of your methods by reflection?
Answer:

No.

Question (exec-process): Do you execute an external process from your module? How do you ensure that the result is the same on different platforms? Do you parse output? Do you depend on result code?
Answer:

No.

Question (exec-introspection): Does your module use any kind of runtime type information (instanceof, work with java.lang.Class, etc.)?
Answer:

No.

Question (exec-threading): What threading models, if any, does your module adhere to? How the project behaves with respect to threading?
Answer:

N/A.

Question (security-policy): Does your functionality require modifications to the standard policy file?
Answer:

No.

Question (security-grant): Does your code grant additional rights to some other code?
Answer:

No.

Format of files and protocols

Question (format-types): Which protocols and file formats (if any) does your module read or write on disk, or transmit or receive over the network? Do you generate an ant build script? Can it be edited and modified?
Answer:

None.

Question (format-dnd): Which protocols (if any) does your code understand during Drag & Drop?
Answer:

None.

Question (format-clipboard): Which data flavors (if any) does your code read from or insert to the clipboard (by access to clipboard on means calling methods on java.awt.datatransfer.Transferable?
Answer:

None.

Performance and Scalability

Question (perf-startup): Does your module run any code on startup?
Answer:

No.

Question (perf-exit): Does your module run any code on exit?
Answer:

No.

Question (perf-scale): Which external criteria influence the performance of your program (size of file in editor, number of files in menu, in source directory, etc.) and how well your code scales?
Answer:

None.

Question (perf-limit): Are there any hard-coded or practical limits in the number or size of elements your code can handle?
Answer:

No.

Question (perf-mem): How much memory does your component consume? Estimate with a relation to the number of windows, etc.
Answer:

N/A.

Question (perf-wakeup): Does any piece of your code wake up periodically and do something even when the system is otherwise idle (no user interaction)?
Answer:

No.

Question (perf-progress): Does your module execute any long-running tasks?
Answer:

No.

Question (perf-huge_dialogs): Does your module contain any dialogs or wizards with a large number of GUI controls such as combo boxes, lists, trees, or text areas?
Answer:

No.

Question (perf-menus): Does your module use dynamically updated context menus, or context-sensitive actions with complicated and slow enablement logic?
Answer:

No.

Question (perf-spi): How the performance of the plugged in code will be enforced?
Answer:

N/A.