blob: 48d530c9bf944bbddb2d04814336a363f5c009bb [file] [log] [blame]
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* Tools for SIS tests. This package defines a base class, {@link org.apache.sis.test.TestCase},
* which is extended directly or indirectly by most (but not all) SIS tests.
* This package defines also an {@link org.apache.sis.test.Assert} class which extend the GeoAPI
* {@link org.opengis.test.Assert} (which itself extends the JUnit {@link org.junit.Assert} class)
* with the addition of assertion methods commonly used in SIS tests.
*
* <h2>Outputs configuration</h2>
* By default, successful tests do not produce any output. However it is possible to ask for
* verbose outputs, which is sometime useful for debugging purpose. This behavior is controlled
* from the command line by defining {@linkplain java.lang.System#getProperties() system properties}
* values like below:
*
* <ul class="verbose">
* <li><b>{@code -Dorg.apache.sis.test.verbose=true}</b><br>
* For enabling verbose outputs to the {@linkplain java.lang.System#console() console} if any,
* or to the {@linkplain java.lang.System#out standard output stream} otherwise.</li>
*
* <li><b>{@code -Dorg.apache.sis.test.encoding=UTF-8}</b> (or any other valid encoding name)<br>
* For the encoding of the above-cited verbose output, and the encoding of logging messages
* sent to the {@linkplain java.util.logging.ConsoleHandler console handler}.
* This is useful on Windows or MacOS platforms having a console encoding different than the
* platform encoding. If omitted, then the platform encoding will be used.</li>
* </ul>
*
* @author Martin Desruisseaux (Geomatys)
* @version 1.1
* @since 0.3
* @module
*/
package org.apache.sis.test;