Repository: airavata Updated Branches: refs/heads/master 2c6620f03 -> f742ebde1
http://git-wip-us.apache.org/repos/asf/airavata/blob/f742ebde/thrift-interface-descriptions/orchestrator-cpi/generate-orchestrator-stubs.sh ---------------------------------------------------------------------- diff --git a/thrift-interface-descriptions/orchestrator-cpi/generate-orchestrator-stubs.sh b/thrift-interface-descriptions/orchestrator-cpi/generate-orchestrator-stubs.sh new file mode 100755 index 0000000..4e088fe --- /dev/null +++ b/thrift-interface-descriptions/orchestrator-cpi/generate-orchestrator-stubs.sh @@ -0,0 +1,132 @@ +#! /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 +# +# 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. + +# This script will regenerate the thrift code for Airavata Orchestrator Server Skeltons and Client Stubs. + + +# Global Constants used across the script +REQUIRED_THRIFT_VERSION='0.9.2' +BASE_TARGET_DIR='target' +ORCHESTRATOR_SERVICE_DIR='../../modules/orchestrator/orchestrator-client/src/main/java' + +# The Funcation fail prints error messages on failure and quits the script. +fail() { + echo $@ + exit 1 +} + +# The funcation add_license_header adds the ASF V2 license header to all java files within the specified generated +# directory. The funcation also adds suppress all warnings annotation to all public classes and enum's +# To Call: +# add_license_header $generated_code_directory +add_license_header() { + + # Fetch the generated code directory passed as the argument + GENERATED_CODE_DIR=$1 + + # For all generated thrift code, add the suppress all warnings annotation + # NOTE: In order to save the orginal file as a backup, use sed -i.orig in place of sed -i '' + find ${GENERATED_CODE_DIR} -name '*.java' -print0 | xargs -0 sed -i '' -e 's/public class /@SuppressWarnings("all") public class /' + find ${GENERATED_CODE_DIR} -name '*.java' -print0 | xargs -0 sed -i '' -e 's/public enum /@SuppressWarnings("all") public enum /' + + # For each java file within the genrated directory, add the ASF V2 LICENSE header + for f in $(find ${GENERATED_CODE_DIR} -name '*.java'); do + cat - ${f} >${f}-with-license <<EOF + /* + * 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. + */ +EOF + mv ${f}-with-license ${f} + done +} + +# The funcation compares every generated java file with the one in specified existing source location. If the comparision +# shows a difference, then it replaces with the newly generated file (with added license header). +# To Call: +# copy_changed_files $generated_code_directory $existing_source_directory +copy_changed_files() { + + # Read all the funcation arguments + GENERATED_CODE_DIR=$1 + WORKSPACE_SRC_DIR=$2 + + echo "Generated sources are in ${GENERATED_CODE_DIR}" + echo "Destination workspace is in ${WORKSPACE_SRC_DIR}" + + # Check if the newly generated files exist in the targetted workspace, if not copy. Only changed files will be synced. + # the extra slash to GENERATED_CODE_DIR is needed to ensure the parent directory itself is not copied. + rsync -auv ${GENERATED_CODE_DIR}/ ${WORKSPACE_SRC_DIR} +} + +# Generation of thrift files will require installing Apache Thrift. Please add thrift to your path. +# Verify is thrift is installed, is in the path is at a specified version. +VERSION=$(thrift -version 2>/dev/null | grep -F "${REQUIRED_THRIFT_VERSION}" | wc -l) +if [ "$VERSION" -ne 1 ] ; then + echo "****************************************************" + echo "*** thrift is not installed or is not in the path" + echo "*** expecting 'thrift -version' to return ${REQUIRED_THRIFT_VERSION}" + echo "*** generated code will not be updated" + fail "****************************************************" +fi + +# Initialize the thrift arguements. +# Since most of the Airavata API and Data Models have includes, use recursive option by defualt. +# Generate all the files in target directory +THRIFT_ARGS="-r -o ${BASE_TARGET_DIR}" +# Ensure the required target directories exists, if not create. +mkdir -p ${BASE_TARGET_DIR} + +####################################################################### +# Generate/Update the orchestrator CPI service stubs +# To start with both the servicer and client are in same package, but +# needs to be split using a common generated api-boilerplate-code +####################################################################### + +#Java generation directory +JAVA_GEN_DIR=${BASE_TARGET_DIR}/gen-java + +# As a precausion remove and previously generated files if exists +rm -rf ${JAVA_GEN_DIR} + +# Using thrify Java generator, generate the java classes based on Airavata API. This +# The airavata-api.thrift includes rest of data models. +thrift ${THRIFT_ARGS} --gen java orchestrator.cpi.service.thrift || fail unable to generate java thrift classes + +# For the generated java classes add the ASF V2 License header +add_license_header $JAVA_GEN_DIR + +# Compare the newly generated classes with existing java generated skelton/stub sources and replace the changed ones. +copy_changed_files ${JAVA_GEN_DIR} ${ORCHESTRATOR_SERVICE_DIR} + +# CleanUp: Delete the base target build directory +#rm -rf ${BASE_TARGET_DIR} + +echo "Successfully generated new sources, compared against exiting code and replaced the changed files" +exit 0 http://git-wip-us.apache.org/repos/asf/airavata/blob/f742ebde/thrift-interface-descriptions/orchestrator-cpi/orchestrator.cpi.service.thrift ---------------------------------------------------------------------- diff --git a/thrift-interface-descriptions/orchestrator-cpi/orchestrator.cpi.service.thrift b/thrift-interface-descriptions/orchestrator-cpi/orchestrator.cpi.service.thrift new file mode 100644 index 0000000..1b7a2ea --- /dev/null +++ b/thrift-interface-descriptions/orchestrator-cpi/orchestrator.cpi.service.thrift @@ -0,0 +1,78 @@ +/* + * 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. + * + */ + +/* + * Component Programming Interface definition for Apache Airavata Orchestration Service. + * +*/ + +include "../airavata-api/airavata-errors.thrift" +namespace java org.apache.airavata.orchestrator.cpi + +const string ORCHESTRATOR_CPI_VERSION = "0.13.0" + +service OrchestratorService { + + /** Query orchestrator server to fetch the CPI version */ + string getOrchestratorCPIVersion(), + + /** + * After creating the experiment Data user have the + * experimentID as the handler to the experiment, during the launchExperiment + * We just have to give the experimentID + * + * @param experimentID + * @return sucess/failure + * + **/ + bool launchExperiment (1: required string experimentId, 2: required string airavataCredStoreToken), + + /** + * In order to run single applications users should create an associating + * WorkflowNodeDetails and a TaskDetails for it and hand it over for execution + * along with a credential store token for authentication + * + * @param taskId + * @param airavataCredStoreToken + * @return sucess/failure + * + **/ + bool launchTask (1: required string taskId, 2: required string airavataCredStoreToken), + + /** + * + * Validate funcations which can verify if the experiment is ready to be launced. + * + * @param experimentID + * @return sucess/failure + * + **/ + bool validateExperiment(1: required string experimentId) + throws (1: airavataErrors.LaunchValidationException lve) + /** + * + * Terminate the running experiment. + * + * @param experimentID + * @return sucess/failure + * + **/ + bool terminateExperiment (1: required string experimentId, 2: required string tokenId) +}
