utils.sh

#!/bin/bash

# Copyright 2019 IBM Corp.

# 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

# 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 file contains serveral utils to help test end-to-end tests.

# Set environment variable
export PATH=${PWD}:$PATH
export PEER_CONFIG_PATH=${IPFS_PATH}/peer
export SERVER_CONFIG_PATH=${IPFS_PATH}/server
export LOG_PATH=${IPFS_PATH}/data

# Set file and web
FILE_TYPE=txt
WEB_TYPE=html
FILE_NAME=file_example.${FILE_TYPE}
WEB_NAME=web_example.${WEB_TYPE}
# Set ipns prefix
IPNS_PREFIX=/ipns
# Set valided time for the web
VALIDED_TIME=8760h

# Verify execution result
verifyResult() {
	if [ $1 -ne 0 ]; then
		echo "==== $2 ===="
		echo
		echo "==== Failed to excute end-to-end test, exit. ===="
		echo
		exit 1
	fi
}

# Set enviroment path
setGlobals() {
	NETWORK=$1
	if [ "$NETWORK" == "p2p" ]; then
		PEER_SRC_PATH=/opt/gopath/src/github.com/IBM/IPFSfB/p2p/peer/artifacts
	elif [ "$NETWORK" == "p2s" ]; then
		PEER_SRC_PATH=/opt/gopath/src/github.com/IBM/IPFSfB/p2s/peer/artifacts
		SERVER_SRC_PATH=/opt/gopath/src/github.com/IBM/IPFSfB/p2s/server/artifacts
	elif [ "$NETWORK" == "p2sp" ]; then
		PEER_SRC_PATH=/opt/gopath/src/github.com/IBM/IPFSfB/p2sp/peer/artifacts
		SERVER_SRC_PATH=/opt/gopath/src/github.com/IBM/IPFSfB/p2sp/server/artifacts
	else
		SERVER_SRC_PATH=/opt/gopath/src/github.com/IBM/IPFSfB/server/artifacts
	fi
}

# Upload files to IPFS
uploadFiles() {
	setGlobals $NETWORK
	set -x
	if [ "$NETWORK" == "p2p" ]; then
		ipfs add -q ${PEER_SRC_PATH}/${FILE_NAME} >&$LOG_PATH/log.txt
	else
		ipfs add -q ${SERVER_SRC_PATH}/${FILE_NAME} >&$LOG_PATH/log.txt
	fi
	res=$?
	set +x
	cat $LOG_PATH/log.txt
	verifyResult $res "Error!!! Unable to upload files to IPFS on ${IPFS_HOST}."
	echo "==== Successfully uploaded file ${FILE_NAME} to IPFS on ${IPFS_HOST} on the private network '$NETWORK'. ===="
	echo
}

# View files from IPFS
viewFiles() {
	HASH=$(cat $LOG_PATH/log.txt | head -n 1)
	set -x
	ipfs cat $HASH >>$LOG_PATH/log.txt
	res=$?
	set +x
	cat $LOG_PATH/log.txt
	verifyResult $res "Error!!! Unable to view files from IPFS on ${IPFS_HOST}."
	echo "==== Successfully viewed a file $HASH from IPFS on ${IPFS_HOST} on the private network '$NETWORK'. ===="
	echo
}

# Download files from IPFS
downloadFiles() {
	HASH=$(cat $LOG_PATH/log.txt | head -n 1)
	set -x
	if [ "$NETWORK" != "so" ]; then
		ipfs get $HASH -o ${PEER_CONFIG_PATH}/${FILE_NAME} >>$LOG_PATH/log.txt
	else
		ipfs get $HASH -o ${SERVER_CONFIG_PATH}/${FILE_NAME} >>$LOG_PATH/log.txt
	fi
	res=$?
	set +x
	cat $LOG_PATH/log.txt
	verifyResult $res "Error!!! Unable to download files from IPFS on ${IPFS_HOST}."
	echo "==== Successfully downloaded a file ${FILE_NAME} from IPFS on ${IPFS_HOST} on the private network '$NETWORK'. ===="
	echo
}

# Publish web to IPFS
publishWeb() {
	setGlobals $NETWORK
	set -x
	if [ "$NETWORK" == "p2p" ]; then
		ipfs add -wq ${PEER_SRC_PATH}/${WEB_NAME} >&$LOG_PATH/log.txt
	else
		ipfs add -wq ${SERVER_SRC_PATH}/${WEB_NAME} >&$LOG_PATH/log.txt
	fi
	res=$?
	set +x
	cat $LOG_PATH/log.txt
	verifyResult $res "Error!!! Unable to publish websites to IPFS on ${IPFS_HOST}."
	echo "==== Successfully published a web ${WEB_NAME} to IPFS on ${IPFS_HOST} on the private network '$NETWORK'. ===="
	echo
	if [ "$NETWORK" != "p2p" ]; then
		IPFS_HASH=$(cat $LOG_PATH/log.txt | tail -n 1)
		set -x
		ipfs name publish -t $VALIDED_TIME -Q $IPFS_HASH >>$LOG_PATH/log.txt
		IPNS_HASH=$(cat $LOG_PATH/log.txt | tail -n 1)
		ipfs name resolve $IPNS_HASH >>log.txt
		res=$?
		set +x
		cat $LOG_PATH/log.txt
		verifyResult $res "Error!!! Unable to publish websites to IPNS on ${IPFS_HOST}."
		echo "==== Successfully published a web ${WEB_NAME} to IPNS on ${IPFS_HOST} on the private network '$NETWORK'. ===="
		echo
	fi
}

# Query web content from IPFS
queryWeb() {
	if [ "$NETWORK" != "p2p" ]; then
		IPFS_HASH=$(cat $LOG_PATH/log.txt | sed -n 2p)
	else
		IPFS_HASH=$(cat $LOG_PATH/log.txt | tail -n 1)
	fi
	set -x
	pup -f <(ipfs cat $IPFS_HASH/${WEB_NAME}) pre text{} >>$LOG_PATH/log.txt
	res=$?
	set +x
	cat $LOG_PATH/log.txt
	verifyResult $res "Error!!! Unable to query website contents from IPFS on ${IPFS_HOST}."
	echo "==== Successfully queried a web content $IPFS_HASH/${WEB_NAME} from IPFS on ${IPFS_HOST} on the private network '$NETWORK'. ===="
	echo
	if [ "$NETWORK" != "p2p" ]; then
		IPNS_HASH=$(cat $LOG_PATH/log.txt | sed -n 3p)
		set -x
		pup -f <(ipfs cat $IPNS_PREFIX/$IPNS_HASH/${WEB_NAME}) pre text{} >>$LOG_PATH/log.txt
		res=$?
		set +x
		cat $LOG_PATH/log.txt
		verifyResult $res "Error!!! Unable to query website contents from IPNS on ${IPFS_HOST}."
		echo "==== Successfully queried a web content $IPNS_PREFIX/$IPNS_HASH/${WEB_NAME} from IPNS on ${IPFS_HOST} on the private network '$NETWORK'. ===="
		echo
	fi
}

# The arg of the command
COMMAND=$1
NETWORK=$2
shift

# Command interface for execution
if [ "${COMMAND}" == "uploadFiles" ]; then
	uploadFiles
elif [ "${COMMAND}" == "viewFiles" ]; then
	viewFiles
elif [ "${COMMAND}" == "downloadFiles" ]; then
	downloadFiles
elif [ "${COMMAND}" == "publishWeb" ]; then
	publishWeb
elif [ "${COMMAND}" == "queryWeb" ]; then
	queryWeb
else
	exit 1
fi