HBASE-19477 Moved and aligned documentation in hbase-annotations
This commit is contained in:
Jan Hentschel
parent
de6f0fbdaa
commit
2a468d5421
|
|
@ -1,5 +1,4 @@
|
|||
/*
|
||||
*
|
||||
* 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
|
||||
|
|
@ -17,9 +16,12 @@
|
|||
* limitations under the License.
|
||||
*/
|
||||
|
||||
package org.apache.hadoop.hbase.testclassification;
|
||||
|
||||
/**
|
||||
* Tag a test as related to the client, This tests the hbase-client package and all of the client
|
||||
* Tag a test as related to the client. This tests the hbase-client package and all of the client
|
||||
* tests in hbase-server.
|
||||
*
|
||||
* @see org.apache.hadoop.hbase.testclassification.ClientTests
|
||||
* @see org.apache.hadoop.hbase.testclassification.CoprocessorTests
|
||||
* @see org.apache.hadoop.hbase.testclassification.FilterTests
|
||||
|
|
@ -35,7 +37,5 @@
|
|||
* @see org.apache.hadoop.hbase.testclassification.VerySlowRegionServerTests
|
||||
* @see org.apache.hadoop.hbase.testclassification.VerySlowMapReduceTests
|
||||
*/
|
||||
package org.apache.hadoop.hbase.testclassification;
|
||||
|
||||
public interface ClientTests {
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,5 +1,4 @@
|
|||
/*
|
||||
*
|
||||
* 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
|
||||
|
|
@ -17,8 +16,11 @@
|
|||
* limitations under the License.
|
||||
*/
|
||||
|
||||
package org.apache.hadoop.hbase.testclassification;
|
||||
|
||||
/**
|
||||
* Tag a test as related to coprocessors.
|
||||
*
|
||||
* @see org.apache.hadoop.hbase.testclassification.ClientTests
|
||||
* @see org.apache.hadoop.hbase.testclassification.CoprocessorTests
|
||||
* @see org.apache.hadoop.hbase.testclassification.FilterTests
|
||||
|
|
@ -34,8 +36,5 @@
|
|||
* @see org.apache.hadoop.hbase.testclassification.VerySlowRegionServerTests
|
||||
* @see org.apache.hadoop.hbase.testclassification.VerySlowMapReduceTests
|
||||
*/
|
||||
package org.apache.hadoop.hbase.testclassification;
|
||||
|
||||
|
||||
public interface CoprocessorTests {
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,5 +1,4 @@
|
|||
/*
|
||||
*
|
||||
* 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
|
||||
|
|
@ -17,8 +16,11 @@
|
|||
* limitations under the License.
|
||||
*/
|
||||
|
||||
package org.apache.hadoop.hbase.testclassification;
|
||||
|
||||
/**
|
||||
* Tag a test as related to the filter package.
|
||||
* Tag a test as related to the {@link org.apache.hadoop.hbase.filter} package.
|
||||
*
|
||||
* @see org.apache.hadoop.hbase.testclassification.ClientTests
|
||||
* @see org.apache.hadoop.hbase.testclassification.CoprocessorTests
|
||||
* @see org.apache.hadoop.hbase.testclassification.FilterTests
|
||||
|
|
@ -34,8 +36,5 @@
|
|||
* @see org.apache.hadoop.hbase.testclassification.VerySlowRegionServerTests
|
||||
* @see org.apache.hadoop.hbase.testclassification.VerySlowMapReduceTests
|
||||
*/
|
||||
package org.apache.hadoop.hbase.testclassification;
|
||||
|
||||
|
||||
public interface FilterTests {
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,5 +1,4 @@
|
|||
/*
|
||||
*
|
||||
* 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
|
||||
|
|
@ -17,8 +16,11 @@
|
|||
* limitations under the License.
|
||||
*/
|
||||
|
||||
package org.apache.hadoop.hbase.testclassification;
|
||||
|
||||
/**
|
||||
* Tag a test as failing commonly on public build infrastructure.
|
||||
*
|
||||
* @see org.apache.hadoop.hbase.testclassification.ClientTests
|
||||
* @see org.apache.hadoop.hbase.testclassification.CoprocessorTests
|
||||
* @see org.apache.hadoop.hbase.testclassification.FilterTests
|
||||
|
|
@ -34,7 +36,5 @@
|
|||
* @see org.apache.hadoop.hbase.testclassification.VerySlowRegionServerTests
|
||||
* @see org.apache.hadoop.hbase.testclassification.VerySlowMapReduceTests
|
||||
*/
|
||||
package org.apache.hadoop.hbase.testclassification;
|
||||
|
||||
public interface FlakeyTests {
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,5 +1,4 @@
|
|||
/*
|
||||
*
|
||||
* 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
|
||||
|
|
@ -17,8 +16,12 @@
|
|||
* limitations under the License.
|
||||
*/
|
||||
|
||||
package org.apache.hadoop.hbase.testclassification;
|
||||
|
||||
/**
|
||||
* Tag a test as related to the io package. Things like HFile and the like.
|
||||
* Tag a test as related to the {@link org.apache.hadoop.hbase.io} package. Things like HFile and
|
||||
* the like.
|
||||
*
|
||||
* @see org.apache.hadoop.hbase.testclassification.ClientTests
|
||||
* @see org.apache.hadoop.hbase.testclassification.CoprocessorTests
|
||||
* @see org.apache.hadoop.hbase.testclassification.FilterTests
|
||||
|
|
@ -34,8 +37,5 @@
|
|||
* @see org.apache.hadoop.hbase.testclassification.VerySlowRegionServerTests
|
||||
* @see org.apache.hadoop.hbase.testclassification.VerySlowMapReduceTests
|
||||
*/
|
||||
package org.apache.hadoop.hbase.testclassification;
|
||||
|
||||
|
||||
public interface IOTests {
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
/**
|
||||
/*
|
||||
* 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
|
||||
|
|
@ -20,7 +20,8 @@ package org.apache.hadoop.hbase.testclassification;
|
|||
|
||||
/**
|
||||
* Tag a test as 'integration/system' test, meaning that the test class has the following
|
||||
* characteristics: <ul>
|
||||
* characteristics:
|
||||
* <ul>
|
||||
* <li> Possibly takes hours to complete</li>
|
||||
* <li> Can be run on a mini cluster or an actual cluster</li>
|
||||
* <li> Can make changes to the given cluster (starting stopping daemons, etc)</li>
|
||||
|
|
|
|||
|
|
@ -1,5 +1,4 @@
|
|||
/*
|
||||
*
|
||||
* 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
|
||||
|
|
@ -22,10 +21,12 @@ package org.apache.hadoop.hbase.testclassification;
|
|||
/**
|
||||
* Tag a test as 'large', meaning that the test class has the following
|
||||
* characteristics:
|
||||
* - executed in an isolated JVM. Tests can however be executed in different
|
||||
* JVM on the same machine simultaneously.
|
||||
* - will not have to be executed by the developer before submitting a bug
|
||||
* - ideally, last less than 2 minutes to help parallelization
|
||||
* <ul>
|
||||
* <li>executed in an isolated JVM. Tests can however be executed in different JVM on the same
|
||||
* machine simultaneously.</li>
|
||||
* <li>will not have to be executed by the developer before submitting a bug</li>
|
||||
* <li>ideally, last less than 2 minutes to help parallelization</li>
|
||||
* </ul>
|
||||
*
|
||||
* It the worst case compared to small or medium, use it only for tests that
|
||||
* you cannot put in the other categories
|
||||
|
|
|
|||
|
|
@ -1,5 +1,4 @@
|
|||
/*
|
||||
*
|
||||
* 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
|
||||
|
|
@ -17,8 +16,11 @@
|
|||
* limitations under the License.
|
||||
*/
|
||||
|
||||
package org.apache.hadoop.hbase.testclassification;
|
||||
|
||||
/**
|
||||
* Tag a test as related to mapred or mapreduce,
|
||||
* Tag a test as related to mapred or mapreduce.
|
||||
*
|
||||
* @see org.apache.hadoop.hbase.testclassification.ClientTests
|
||||
* @see org.apache.hadoop.hbase.testclassification.CoprocessorTests
|
||||
* @see org.apache.hadoop.hbase.testclassification.FilterTests
|
||||
|
|
@ -34,7 +36,5 @@
|
|||
* @see org.apache.hadoop.hbase.testclassification.VerySlowRegionServerTests
|
||||
* @see org.apache.hadoop.hbase.testclassification.VerySlowMapReduceTests
|
||||
*/
|
||||
package org.apache.hadoop.hbase.testclassification;
|
||||
|
||||
public interface MapReduceTests {
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,5 +1,4 @@
|
|||
/*
|
||||
*
|
||||
* 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
|
||||
|
|
@ -17,8 +16,11 @@
|
|||
* limitations under the License.
|
||||
*/
|
||||
|
||||
package org.apache.hadoop.hbase.testclassification;
|
||||
|
||||
/**
|
||||
* Tag a test as related to the master.
|
||||
*
|
||||
* @see org.apache.hadoop.hbase.testclassification.ClientTests
|
||||
* @see org.apache.hadoop.hbase.testclassification.CoprocessorTests
|
||||
* @see org.apache.hadoop.hbase.testclassification.FilterTests
|
||||
|
|
@ -34,7 +36,5 @@
|
|||
* @see org.apache.hadoop.hbase.testclassification.VerySlowRegionServerTests
|
||||
* @see org.apache.hadoop.hbase.testclassification.VerySlowMapReduceTests
|
||||
*/
|
||||
package org.apache.hadoop.hbase.testclassification;
|
||||
|
||||
public interface MasterTests {
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,5 +1,4 @@
|
|||
/*
|
||||
*
|
||||
* 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
|
||||
|
|
@ -22,10 +21,12 @@ package org.apache.hadoop.hbase.testclassification;
|
|||
/**
|
||||
* Tag a test as 'Medium', meaning that the test class has the following
|
||||
* characteristics:
|
||||
* - executed in an isolated JVM. Tests can however be executed in different
|
||||
* JVM on the same machine simultaneously.
|
||||
* - will have to be executed by the developer before submitting a bug
|
||||
* - ideally, last less than 1 minutes to help parallelization
|
||||
* <ul>
|
||||
* <li>executed in an isolated JVM. Tests can however be executed in different JVM on the same
|
||||
* machine simultaneously.</li>
|
||||
* <li>will have to be executed by the developer before submitting a bug</li>
|
||||
* <li>ideally, last less than 1 minutes to help parallelization</li>
|
||||
* </ul>
|
||||
*
|
||||
* Use it for tests that cannot be tagged as 'Small'.
|
||||
*
|
||||
|
|
|
|||
|
|
@ -16,10 +16,10 @@
|
|||
* limitations under the License.
|
||||
*/
|
||||
|
||||
/**
|
||||
* Tag a test that covers our metrics handling
|
||||
*/
|
||||
package org.apache.hadoop.hbase.testclassification;
|
||||
|
||||
/**
|
||||
* Tag a test that covers our metrics handling.
|
||||
*/
|
||||
public interface MetricsTests {
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,5 +1,4 @@
|
|||
/*
|
||||
*
|
||||
* 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
|
||||
|
|
@ -17,8 +16,11 @@
|
|||
* limitations under the License.
|
||||
*/
|
||||
|
||||
package org.apache.hadoop.hbase.testclassification;
|
||||
|
||||
/**
|
||||
* Tag a test as not easily falling into any of the below categories.
|
||||
*
|
||||
* @see org.apache.hadoop.hbase.testclassification.ClientTests
|
||||
* @see org.apache.hadoop.hbase.testclassification.CoprocessorTests
|
||||
* @see org.apache.hadoop.hbase.testclassification.FilterTests
|
||||
|
|
@ -34,7 +36,5 @@
|
|||
* @see org.apache.hadoop.hbase.testclassification.VerySlowRegionServerTests
|
||||
* @see org.apache.hadoop.hbase.testclassification.VerySlowMapReduceTests
|
||||
*/
|
||||
package org.apache.hadoop.hbase.testclassification;
|
||||
|
||||
public interface MiscTests {
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,5 +1,4 @@
|
|||
/*
|
||||
*
|
||||
* 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
|
||||
|
|
@ -16,8 +15,12 @@
|
|||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
package org.apache.hadoop.hbase.testclassification;
|
||||
|
||||
/**
|
||||
* Tag a test as related to RPC.
|
||||
*
|
||||
* @see org.apache.hadoop.hbase.testclassification.ClientTests
|
||||
* @see org.apache.hadoop.hbase.testclassification.CoprocessorTests
|
||||
* @see org.apache.hadoop.hbase.testclassification.FilterTests
|
||||
|
|
@ -33,8 +36,5 @@
|
|||
* @see org.apache.hadoop.hbase.testclassification.VerySlowRegionServerTests
|
||||
* @see org.apache.hadoop.hbase.testclassification.VerySlowMapReduceTests
|
||||
*/
|
||||
package org.apache.hadoop.hbase.testclassification;
|
||||
|
||||
|
||||
public interface RPCTests {
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,5 +1,4 @@
|
|||
/*
|
||||
*
|
||||
* 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
|
||||
|
|
@ -17,8 +16,11 @@
|
|||
* limitations under the License.
|
||||
*/
|
||||
|
||||
package org.apache.hadoop.hbase.testclassification;
|
||||
|
||||
/**
|
||||
* Tag a test as related to the regionserver,
|
||||
* Tag a test as related to the regionserver.
|
||||
*
|
||||
* @see org.apache.hadoop.hbase.testclassification.ClientTests
|
||||
* @see org.apache.hadoop.hbase.testclassification.CoprocessorTests
|
||||
* @see org.apache.hadoop.hbase.testclassification.FilterTests
|
||||
|
|
@ -34,8 +36,5 @@
|
|||
* @see org.apache.hadoop.hbase.testclassification.VerySlowRegionServerTests
|
||||
* @see org.apache.hadoop.hbase.testclassification.VerySlowMapReduceTests
|
||||
*/
|
||||
package org.apache.hadoop.hbase.testclassification;
|
||||
|
||||
|
||||
public interface RegionServerTests {
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,5 +1,4 @@
|
|||
/*
|
||||
*
|
||||
* 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
|
||||
|
|
@ -17,8 +16,11 @@
|
|||
* limitations under the License.
|
||||
*/
|
||||
|
||||
package org.apache.hadoop.hbase.testclassification;
|
||||
|
||||
/**
|
||||
* Tag a test as related to replication,
|
||||
* Tag a test as related to replication.
|
||||
*
|
||||
* @see org.apache.hadoop.hbase.testclassification.ClientTests
|
||||
* @see org.apache.hadoop.hbase.testclassification.CoprocessorTests
|
||||
* @see org.apache.hadoop.hbase.testclassification.FilterTests
|
||||
|
|
@ -34,7 +36,5 @@
|
|||
* @see org.apache.hadoop.hbase.testclassification.VerySlowRegionServerTests
|
||||
* @see org.apache.hadoop.hbase.testclassification.VerySlowMapReduceTests
|
||||
*/
|
||||
package org.apache.hadoop.hbase.testclassification;
|
||||
|
||||
public interface ReplicationTests {
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,5 +1,4 @@
|
|||
/*
|
||||
*
|
||||
* 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
|
||||
|
|
@ -17,8 +16,10 @@
|
|||
* limitations under the License.
|
||||
*/
|
||||
|
||||
package org.apache.hadoop.hbase.testclassification;
|
||||
|
||||
/**
|
||||
* Tag a test as related to the rest capability of HBase.
|
||||
* Tag a test as related to the REST capability of HBase.
|
||||
*
|
||||
* @see org.apache.hadoop.hbase.testclassification.ClientTests
|
||||
* @see org.apache.hadoop.hbase.testclassification.CoprocessorTests
|
||||
|
|
@ -35,7 +36,5 @@
|
|||
* @see org.apache.hadoop.hbase.testclassification.VerySlowRegionServerTests
|
||||
* @see org.apache.hadoop.hbase.testclassification.VerySlowMapReduceTests
|
||||
*/
|
||||
package org.apache.hadoop.hbase.testclassification;
|
||||
|
||||
public interface RestTests {
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,5 +1,4 @@
|
|||
/*
|
||||
*
|
||||
* 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
|
||||
|
|
@ -17,6 +16,8 @@
|
|||
* limitations under the License.
|
||||
*/
|
||||
|
||||
package org.apache.hadoop.hbase.testclassification;
|
||||
|
||||
/**
|
||||
* Tag a test as related to security.
|
||||
*
|
||||
|
|
@ -35,8 +36,5 @@
|
|||
* @see org.apache.hadoop.hbase.testclassification.VerySlowRegionServerTests
|
||||
* @see org.apache.hadoop.hbase.testclassification.VerySlowMapReduceTests
|
||||
*/
|
||||
package org.apache.hadoop.hbase.testclassification;
|
||||
|
||||
|
||||
public interface SecurityTests {
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,5 +1,4 @@
|
|||
/*
|
||||
*
|
||||
* 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
|
||||
|
|
@ -22,9 +21,11 @@ package org.apache.hadoop.hbase.testclassification;
|
|||
/**
|
||||
* Tag a test as 'small', meaning that the test class has the following
|
||||
* characteristics:
|
||||
* - can be run simultaneously with other small tests in the same JVM
|
||||
* - ideally, last less than 15 seconds
|
||||
* - does not use a cluster
|
||||
* <ul>
|
||||
* <li>can be run simultaneously with other small tests in the same JVM</li>
|
||||
* <li>ideally, last less than 15 seconds</li>
|
||||
* <li>does not use a cluster</li>
|
||||
* </ul>
|
||||
*
|
||||
* @see MediumTests
|
||||
* @see LargeTests
|
||||
|
|
|
|||
|
|
@ -1,5 +1,4 @@
|
|||
/*
|
||||
*
|
||||
* 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
|
||||
|
|
@ -17,9 +16,12 @@
|
|||
* limitations under the License.
|
||||
*/
|
||||
|
||||
package org.apache.hadoop.hbase.testclassification;
|
||||
|
||||
/**
|
||||
* Tag a test as related to mapreduce and taking longer than 5 minutes to run on public build
|
||||
* infrastructure.
|
||||
*
|
||||
* @see org.apache.hadoop.hbase.testclassification.ClientTests
|
||||
* @see org.apache.hadoop.hbase.testclassification.CoprocessorTests
|
||||
* @see org.apache.hadoop.hbase.testclassification.FilterTests
|
||||
|
|
@ -35,8 +37,5 @@
|
|||
* @see org.apache.hadoop.hbase.testclassification.VerySlowRegionServerTests
|
||||
* @see org.apache.hadoop.hbase.testclassification.VerySlowMapReduceTests
|
||||
*/
|
||||
package org.apache.hadoop.hbase.testclassification;
|
||||
|
||||
|
||||
public interface VerySlowMapReduceTests {
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,5 +1,4 @@
|
|||
/*
|
||||
*
|
||||
* 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
|
||||
|
|
@ -17,10 +16,12 @@
|
|||
* limitations under the License.
|
||||
*/
|
||||
|
||||
package org.apache.hadoop.hbase.testclassification;
|
||||
|
||||
/**
|
||||
* Tag a test as region tests which takes longer than 5 minutes to run on public build
|
||||
* infrastructure.
|
||||
*
|
||||
* @see org.apache.hadoop.hbase.testclassification.ClientTests
|
||||
* @see org.apache.hadoop.hbase.testclassification.CoprocessorTests
|
||||
* @see org.apache.hadoop.hbase.testclassification.FilterTests
|
||||
|
|
@ -36,7 +37,5 @@
|
|||
* @see org.apache.hadoop.hbase.testclassification.VerySlowRegionServerTests
|
||||
* @see org.apache.hadoop.hbase.testclassification.VerySlowMapReduceTests
|
||||
*/
|
||||
package org.apache.hadoop.hbase.testclassification;
|
||||
|
||||
public interface VerySlowRegionServerTests {
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
/**
|
||||
/*
|
||||
* 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
|
||||
|
|
@ -15,11 +15,12 @@
|
|||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
package org.apache.hadoop.hbase.testclassification;
|
||||
|
||||
/**
|
||||
* For tests which test the general logic of zookeeper related tools, such as
|
||||
* {@code RecoverableZooKeeper}, not for tests which depend on zookeeper.
|
||||
* {@code RecoverableZooKeeper}, not for tests which depend on ZooKeeper.
|
||||
*/
|
||||
public interface ZKTests {
|
||||
}
|
||||
|
|
|
|||
Loading…
Reference in New Issue