Skip to content

Commit ff79100

Browse files
brikis98brikis98
authored
Merge pull request #14 from jeckhart/add-commons-commands-from-zk-and-kafka
Add commons commands from package-zookeeper and package-kafka
2 parents 119360e + 524f1d2 commit ff79100

File tree

10 files changed

+461
-4
lines changed

10 files changed

+461
-4
lines changed

‎modules/bash-commons/src/array.sh‎

Lines changed: 45 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,28 @@ function array_contains {
1616
return 1
1717
}
1818

19+
# Splits the given $string into an array of elements based on the given $separator
20+
#
21+
# Examples:
22+
#
23+
# array_split "a,b,c" ","
24+
# Returns: ("a" "b" "c")
25+
#
26+
# Hint:
27+
# When calling this function, use the following construction: ary=( $(array_split "a,b,c" ",") )
28+
#
29+
# Sources:
30+
# - https://stackoverflow.com/a/15988793/2308858
31+
function array_split {
32+
local -r separator="$1"
33+
local -r str="$2"
34+
local -a ary=()
35+
36+
IFS="$separator" read -a ary <<<"$str"
37+
38+
echo ${ary[*]}
39+
}
40+
1941
# Joins the elements of the given array into a string with the given separator between each element.
2042
#
2143
# Examples:
@@ -26,7 +48,7 @@ function array_contains {
2648
function array_join {
2749
local -r separator="$1"
2850
shift
29-
local -ra values=("$@")
51+
local -ar values=("$@")
3052

3153
local out=""
3254
for (( i=0; i<"${#values[@]}"; i++ )); do
@@ -38,3 +60,25 @@ function array_join {
3860

3961
echo -n "$out"
4062
}
63+
64+
# Adds the given $prefix to the beginning of each string element in the given $array
65+
#
66+
# Examples:
67+
#
68+
# array_prepend "P" "a" "b" "c"
69+
# Returns: ("Pa" "Pb" "Pc")
70+
#
71+
# Hint:
72+
# When calling this function, use the following construction: ary=( $(array_prepend "P" "a" "b" "c") )
73+
#
74+
# Sources:
75+
# - https://stackoverflow.com/a/13216833/2308858
76+
#
77+
function array_prepend {
78+
local -r prefix="$1"
79+
shift 1
80+
local -ar ary=($@)
81+
82+
updated_ary=( "${ary[@]/#/$prefix}" )
83+
echo ${updated_ary[*]}
84+
}

‎modules/bash-commons/src/assert.sh‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,38 @@ function assert_value_in_list {
7070
fi
7171
}
7272

73+
# Reads in a list of keys and values and asserts that one and only one of the values is set.
74+
# This is useful for command line options that are mutually exclusive.
75+
# Example:
76+
# assert_exactly_one_of "--opt1" "" "--opt2" "val2" "--opt3" "" "--opt4" ""
77+
# Examples that assert failure:
78+
# assert_exactly_one_of "--opt1" "val1" "--opt2" "val2" "--opt3" "" "--opt4" ""
79+
# assert_exactly_one_of "--opt1" "" "--opt2" "" "--opt3" "" "--opt4" ""
80+
function assert_exactly_one_of {
81+
local -ra args=("$@")
82+
local -r num_args="${#args[@]}"
83+
if [[ "$((num_args % 2))" -ne 0 ]]; then
84+
log_error "This script expects an even number of arguments but received $num_args instead."
85+
exit 1
86+
fi
87+
88+
local num_non_empty=0
89+
local -a arg_names=()
90+
91+
# Determine how many arg_vals are non-empty
92+
for (( i=0; i<$((num_args+1)); i+=2 )); do
93+
arg_names+=("${args[i]}")
94+
if [[ ! -z "${args[i+1]}" ]]; then
95+
num_non_empty=$((num_non_empty+1))
96+
fi
97+
done
98+
99+
if [[ "$num_non_empty" -ne 1 ]]; then
100+
log_error "Exactly one of ${arg_names[*]} must be set."
101+
exit 1
102+
fi
103+
}
104+
73105
# Check that this script is running as root or sudo and exit with an error if it's not
74106
function assert_uid_is_root_or_sudo {
75107
if ! os_user_is_root_or_sudo; then

‎modules/bash-commons/src/aws.sh‎

Lines changed: 144 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,11 @@
33
# (a) it's more convenient to fetch specific info you need, such as an EC2 Instance's private IP and (b) so you can
44
# replace these helpers with mocks to do local testing or unit testing.
55

6+
# shellcheck source=./modules/bash-commons/src/assert.sh
7+
source "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/assert.sh"
8+
# shellcheck source=./modules/bash-commons/src/log.sh
9+
source "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/log.sh"
10+
611
# Look up the given path in the EC2 Instance metadata endpoint
712
function aws_lookup_path_in_instance_metadata {
813
local -r path="$1"
@@ -60,6 +65,144 @@ function aws_get_instance_tags {
6065
--filters "Name=resource-type,Values=instance" "Name=resource-id,Values=$instance_id"
6166
}
6267

68+
# Return the value of the $tag_key for the given EC2 Instance $instance_id
69+
function aws_get_instance_tag_val {
70+
local -r tag_key="$1"
71+
local -r instance_id="$2"
72+
local -r instance_region="$3"
73+
74+
local tags
75+
tags=$(aws_get_instance_tags "$instance_id" "$instance_region")
76+
77+
local tag_val
78+
tag_val=$(echo "$tags" | jq -r ".Tags[] | select( .ResourceType == \"instance\" and .Key == \"$tag_key\") | .Value")
79+
80+
echo "$tag_val"
81+
}
82+
83+
# Return all ENIs attached to the current EC2 Instance
84+
function aws_get_enis_for_instance {
85+
local -r instance_id="$1"
86+
local -r aws_region="$2"
87+
88+
aws ec2 describe-network-interfaces --region "$aws_region" --filters "Name=attachment.instance-id,Values=$instance_id"
89+
}
90+
91+
# Find all Elastic Network Interfaces (ENIs) that have a matching $tag_key=$tag_value
92+
function aws_get_enis_for_tag {
93+
local -r tag_key="$1"
94+
local -r tag_value="$2"
95+
local -r aws_region="$3"
96+
97+
aws ec2 describe-network-interfaces --region "$aws_region" --filters "Name=tag:$tag_key,Values=$tag_value"
98+
}
99+
100+
# Given the $network_interfaces_output, return the ID of the ENI at the given $eni_index (zero-based)
101+
#
102+
# Example:
103+
# network_interfaces_output=$(aws_get_enis_for_this_ec2_instance)
104+
# aws_get_eni_id "$network_interfaces_output" 0
105+
function aws_get_eni_id {
106+
local -r network_interfaces_output="$1"
107+
local -r eni_device_index="$2"
108+
109+
assert_not_empty "network_interfaces_output" "$network_interfaces_output" "Value returned from AWS API describe-network-interfaces output"
110+
assert_not_empty "eni_device_index" "$eni_device_index"
111+
112+
local num_enis
113+
num_enis=$(echo "$network_interfaces_output" | jq -r ".NetworkInterfaces | length")
114+
115+
if [[ "$num_enis" -lt 1 ]]; then
116+
log_error "Expected to find at least 1 ENI in AWS API describe-network-interfaces output."
117+
exit 1
118+
fi
119+
120+
if [[ "$num_enis" -lt "$eni_device_index" ]]; then
121+
log_error "Requested an ENI device-index out of range from describe-network-interfaces output."
122+
exit 1
123+
fi
124+
125+
local eni_id
126+
eni_id=$(echo "$network_interfaces_output" | jq -r ".NetworkInterfaces[] | select(.Attachment.DeviceIndex == $eni_device_index).NetworkInterfaceId")
127+
128+
assert_not_empty_or_null "$eni_id" "No ENI exists whose DeviceIndex property is $eni_device_index. Did you forget to create or attach an additional ENI?"
129+
130+
echo "$eni_id"
131+
}
132+
133+
# Given a $tag_key, return the corresponding tag_val for the ENI at the the given $eni_device_index (zero-based).
134+
#
135+
# Example:
136+
# network_interfaces_output=$(aws_get_enis_for_this_ec2_instance)
137+
# aws_get_eni_tag_val "$network_interfaces_output" 0 "DnsName"
138+
function aws_get_eni_tag_val {
139+
local -r network_interfaces_output="$1"
140+
local -r eni_device_index="$2"
141+
local -r tag_key="$3"
142+
143+
assert_not_empty "tag_key" "$tag_key"
144+
145+
local eni_id
146+
eni_id="$(aws_get_eni_id "$network_interfaces_output" "$eni_device_index")"
147+
log_info "Looking up the value of the tag \"$tag_key\" for ENI $eni_id"
148+
149+
local tag_val
150+
tag_val=$(echo "$network_interfaces_output" | jq -j ".NetworkInterfaces[] | select(.NetworkInterfaceId == \"$eni_id\").TagSet[] | select(.Key == \"$tag_key\").Value")
151+
152+
assert_not_empty_or_null_warn "$tag_val" "Found empty value when looking up tag \"$tag_key\" for ENI $eni_id"
153+
154+
echo "$tag_val"
155+
}
156+
157+
# Return the *public* IP Address of for the ENI at the the given $eni_device_index (zero-based).
158+
#
159+
# Example:
160+
# network_interfaces_output=$(aws_get_enis_for_this_ec2_instance)
161+
# aws_get_eni_public_ip "$network_interfaces_output" 0
162+
function aws_get_eni_public_ip {
163+
local -r network_interfaces_output="$1"
164+
local -r eni_device_index="$2"
165+
166+
local eni_id
167+
eni_id="$(aws_get_eni_id "$network_interfaces_output" "$eni_device_index")"
168+
log_info "Looking up public IP address for ENI $eni_id"
169+
170+
public_ip=$(echo "$network_interfaces_output" | jq -j ".NetworkInterfaces[] | select(.NetworkInterfaceId == \"$eni_id\").PrivateIpAddresses[0].Association.PublicIp")
171+
172+
assert_not_empty_or_null "$public_ip" "No public IP address found for ENI $eni_id."
173+
174+
echo "$public_ip"
175+
}
176+
177+
# Return the *private* IP Address of for the ENI at the the given $eni_device_index (zero-based).
178+
#
179+
# Example:
180+
# network_interfaces_output=$(aws_get_enis_for_this_ec2_instance)
181+
# aws_get_eni_private_ip "$network_interfaces_output" 0
182+
function aws_get_eni_private_ip {
183+
local -r network_interfaces_output="$1"
184+
local -r eni_device_index="$2"
185+
186+
local eni_id
187+
eni_id="$(aws_get_eni_id "$network_interfaces_output" "$eni_device_index")"
188+
log_info "Looking up private IP address for ENI $eni_id"
189+
190+
public_ip=$(echo "$network_interfaces_output" | jq -j ".NetworkInterfaces[] | select(.NetworkInterfaceId == \"$eni_id\").PrivateIpAddresses[0].PrivateIpAddress")
191+
192+
echo "$public_ip"
193+
}
194+
195+
# Return the private IP Address of the ENI attached to the given EC2 Instance
196+
function aws_get_eni_private_ip_for_instance {
197+
local -r network_interfaces_output="$1"
198+
local -r instance_id="$2"
199+
200+
local attached_network_interface
201+
attached_network_interface=$(echo "$network_interfaces_output" | jq -r ".NetworkInterfaces[] | select(.Attachment.InstanceId == \"$instance_id\")")
202+
203+
echo "$attached_network_interface" | jq -r '.PrivateIpAddresses[0].PrivateIpAddress'
204+
}
205+
63206
# Get the instances with a given tag and in a specific region. Returns JSON from the AWS CLI's describe-instances command.
64207
function aws_get_instances_with_tag {
65208
local -r tag_key="$1"
@@ -86,4 +229,4 @@ function aws_describe_instances_in_asg {
86229
local -r aws_region="$2"
87230

88231
aws ec2 describe-instances --region "$aws_region" --filters "Name=tag:aws:autoscaling:groupName,Values=$asg_name" "Name=instance-state-name,Values=pending,running"
89-
}
232+
}

‎modules/bash-commons/src/file.sh‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,18 @@ function file_replace_text {
5050
sudo sed "${args[@]}" > /dev/null
5151
}
5252

53+
# Call file_replace_text for each of the files listed in $files[@]
54+
function file_replace_text_in_files {
55+
local -r original_text_regex="$1"
56+
local -r replacement_text="$2"
57+
shift 2
58+
local -ar files=("$@")
59+
60+
for file in "${files[@]}"; do
61+
file_replace_text "$original_text_regex" "$replacement_text" "$file"
62+
done
63+
}
64+
5365
# If the given file already contains the original text (which is a regex), replace it with the given replacement. If
5466
# it doesn't contain that text, simply append the replacement text at the end of the file.
5567
function file_replace_or_append_text {

‎modules/bash-commons/src/os.sh‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,3 +84,30 @@ function os_get_current_users_group {
8484
function os_user_is_root_or_sudo {
8585
[[ "$EUID" == 0 ]]
8686
}
87+
88+
# Returns a zero exit code if the given $username exists
89+
function os_user_exists {
90+
local -r username="$1"
91+
id "$username" >/dev/null 2>&1
92+
}
93+
94+
# Create an OS user whose name is $username
95+
function os_create_user {
96+
local -r username="$1"
97+
98+
if os_user_exists "$username"; then
99+
log_info "User $username already exists. Will not create again."
100+
else
101+
log_info "Creating user named $username"
102+
useradd "$username"
103+
fi
104+
}
105+
106+
# Change the owner of $dir to $username
107+
function os_change_dir_owner {
108+
local -r dir="$1"
109+
local -r username="$2"
110+
111+
log_info "Changing ownership of $dir to $username"
112+
chown -R "$username:$username" "$dir"
113+
}

‎test/array.bats‎

Lines changed: 62 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,36 @@ load "test-helper"
3838
assert_failure
3939
}
4040

41+
@test "array_split on empty string" {
42+
local ary=( $(array_split "" "") )
43+
status="$?"
44+
assert_success
45+
assert_equal "" "${ary[0]}"
46+
}
47+
48+
@test "array_split on single element string" {
49+
local ary=( $(array_split "," "test") )
50+
status="$?"
51+
assert_success
52+
assert_equal "test" "${ary[0]}"
53+
}
54+
55+
@test "array_split on multi element string" {
56+
local ary=( $(array_split "," "test0,test1") )
57+
status="$?"
58+
assert_success
59+
assert_equal "test0" "${ary[0]}"
60+
assert_equal "test1" "${ary[1]}"
61+
}
62+
63+
@test "array_split on multi element string with multi character separator" {
64+
local ary=( $(array_split "==" "test0==test1") )
65+
status="$?"
66+
assert_success
67+
assert_equal "test0" "${ary[0]}"
68+
assert_equal "test1" "${ary[1]}"
69+
}
70+
4171
@test "array_join on empty array" {
4272
run array_join ","
4373
assert_success
@@ -60,4 +90,35 @@ load "test-helper"
6090
run array_join " == " "foo" "bar" "baz"
6191
assert_success
6292
assert_output "foo == bar == baz"
63-
}
93+
}
94+
95+
@test "array_prepend on empty string" {
96+
local ary=( $(array_prepend "test" "") )
97+
status="$?"
98+
assert_success
99+
assert_equal "" "${ary[0]}"
100+
}
101+
102+
@test "array_prepend on empty prepend string" {
103+
local ary=( $(array_prepend "" "test0" "test1") )
104+
status="$?"
105+
assert_success
106+
assert_equal "test0" "${ary[0]}"
107+
assert_equal "test1" "${ary[1]}"
108+
}
109+
110+
@test "array_prepend on single element string" {
111+
local ary=( $(array_prepend "test" "0") )
112+
status="$?"
113+
assert_success
114+
assert_equal "test0" "${ary[0]}"
115+
}
116+
117+
@test "array_prepend on multi element string" {
118+
local ary=( $(array_prepend "test" "0" "1") )
119+
status="$?"
120+
assert_success
121+
assert_equal "test0" "${ary[0]}"
122+
assert_equal "test1" "${ary[1]}"
123+
}
124+

0 commit comments

Comments
 (0)