aboutsummaryrefslogtreecommitdiff
path: root/bigtop-tests/spec-tests/runtime/src/main/resources/api-examiner-prep.sh
diff options
context:
space:
mode:
authorAlan Gates <alanfgates@gmail.com>2017-03-09 15:39:13 -0800
committerRoman Shaposhnik <rvs@apache.org>2017-03-23 10:27:15 -0700
commit77e0d6e01f3e43f4a7e51a588b2261780c587ae2 (patch)
tree3ba78cab850cd3605aebd88af705a43ccf347425 /bigtop-tests/spec-tests/runtime/src/main/resources/api-examiner-prep.sh
parentc65c0008bd6e4577e6673bd2b6e6a86304f371ad (diff)
Added tests into TestSpecsRuntime and testRuntimeSpecConf so they get run. Tested against an HDP cluster.
(cherry picked from commit a911703ccacc70b738720c560574fc8a9aee8b2b)
Diffstat (limited to 'bigtop-tests/spec-tests/runtime/src/main/resources/api-examiner-prep.sh')
-rwxr-xr-xbigtop-tests/spec-tests/runtime/src/main/resources/api-examiner-prep.sh38
1 files changed, 29 insertions, 9 deletions
diff --git a/bigtop-tests/spec-tests/runtime/src/main/resources/api-examiner-prep.sh b/bigtop-tests/spec-tests/runtime/src/main/resources/api-examiner-prep.sh
index 0bdfe05e..8c9ab5e6 100755
--- a/bigtop-tests/spec-tests/runtime/src/main/resources/api-examiner-prep.sh
+++ b/bigtop-tests/spec-tests/runtime/src/main/resources/api-examiner-prep.sh
@@ -1,16 +1,12 @@
#!/usr/bin/env bash
############################################################################
-# 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
-# <p>
+# Licensed 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
-# <p>
+#
# 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.
@@ -18,6 +14,30 @@
# limitations under the License.
############################################################################
+############################################################################
+# This script is used to generate the hadoop-*-api.report.json files in the
+# test/resources directory. To use it, you will first need to download an
+# Apache binary distribution of Hadoop and set APACHE_HADOOP_DIR to the
+# directory where you untar that distribution. You will then need to set
+# BIGTTOP_HOME to the directory where your bigtop source is located. Then
+# run this script for each of the jars you want to generate a report for.
+# The arguments passed to this script should be -p <outputdir> -j <jarfile>
+# where outputdir is the directory you'd like to write the report to and
+# jarfile is the full path of the jar to generate the report for. Reports
+# should be generated for the following jars: hadoop-common, hadoop-hdfs,
+# hadoop-yarn-common, hadoop-yarn-client, hadoop-yarn-api, and
+# hadoop-mapreduce-client-core
+#
+# Example usage:
+# export APACHE_HADOOP_DIR=/tmp/hadoop-2.7.3
+# export BIGTOP_HOME=/home/me/git/bigtop
+# $BIGTOP_HOME/bigtop-tests/spec-tests/runtime/src/main/resources/api-examiner.sh -j $HADOOP_HOME/share/hadoop/common/hadoop-common-2.7.3.jar -p $BIGTOP_HOME/bigtop-tests/spec-tests/runtime/src/test/resources
+#
+# The resulting reports should be committed to git. This script only needs
+# to be run once per ODPi release.
+############################################################################
+
+
if [ "x${APACHE_HADOOP_DIR}" = "x" ]
then
echo "You must set APACHE_HADOOP_DIR to the directory you have placed the Apache Hadoop binary distribution in"