Skip to content

Commit ddd22a6

Browse files
yorinasub17yorinasub17
authored
Fix build (#36)
* Regression test for sudo functionality * Add Ubuntu 20.04 and propagate exit code * Fix for sudo bug * Fix build failures * Make sure shellcheck container errors are bubbled up * Remove debug statement * Fix docker-compose call for shellcheck
1 parent 9ffcd19 commit ddd22a6

11 files changed

+159
-93
lines changed

‎.circleci/config.yml

+12-3
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ jobs:
44
machine: true
55
steps:
66
- checkout
7-
- run: docker-compose up shellcheck
7+
- run: docker-compose up --exit-code-from shellcheck shellcheck
88
integration_test:
99
docker:
1010
- image: 087285199408.dkr.ecr.us-east-1.amazonaws.com/circle-ci-test-image-base:go1.14
@@ -29,14 +29,22 @@ jobs:
2929
machine: true
3030
steps:
3131
- checkout
32-
- run: docker-compose up bats_ubuntu1604
32+
- run: docker-compose up --exit-code-from bats_ubuntu1604 bats_ubuntu1604
3333
bats_ubuntu1804:
3434
# We need to run Docker Compose with privileged settings, which isn't supported by CircleCI's Docker executor, so
3535
# we have to use the machine executor instead.
3636
machine: true
3737
steps:
3838
- checkout
39-
- run: docker-compose up bats_ubuntu1804
39+
- run: docker-compose up --exit-code-from bats_ubuntu1804 bats_ubuntu1804
40+
bats_ubuntu2004:
41+
# We need to run Docker Compose with privileged settings, which isn't supported by CircleCI's Docker executor, so
42+
# we have to use the machine executor instead.
43+
machine: true
44+
steps:
45+
- checkout
46+
- run: docker-compose up --exit-code-from bats_ubuntu2004 bats_ubuntu2004
47+
4048
workflows:
4149
version: 2
4250
checks:
@@ -47,3 +55,4 @@ workflows:
4755
- Gruntwork Admin
4856
- bats_ubuntu1604
4957
- bats_ubuntu1804
58+
- bats_ubuntu2004

‎Dockerfile.ubuntu16.04.bats

+8-9
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,16 @@ MAINTAINER Gruntwork <[email protected]>
33

44
# Install basic dependencies
55
RUN DEBIAN_FRONTEND=noninteractive apt-get update && \
6-
apt-get install -y vim python-pip jq sudo curl libffi-dev python3-dev && \
6+
apt-get install -y vim git python-pip jq sudo curl libffi-dev python3-dev && \
77
update-alternatives --install /usr/bin/python python /usr/bin/python3 1 && \
88
update-alternatives --config python && \
99
curl https://bootstrap.pypa.io/pip/3.5/get-pip.py -o /tmp/get-pip.py && \
1010
python /tmp/get-pip.py
1111

1212
# Install Bats
13-
RUN apt-get install -y software-properties-common && \
14-
add-apt-repository ppa:duggan/bats && \
15-
DEBIAN_FRONTEND=noninteractive apt-get update && \
16-
apt-get install -y bats
13+
RUN git clone https://github.com/bats-core/bats-core.git /tmp/bats-core && \
14+
/tmp/bats-core/install.sh /usr/local && \
15+
rm -r /tmp/bats-core
1716

1817
# Upgrade pip
1918
RUN pip install -U pip
@@ -25,13 +24,13 @@ RUN pip install awscli --upgrade --user
2524
RUN pip install flask moto moto[server] networkx==2.2
2625

2726
# Install tools we'll need to create a mock EC2 metadata server
28-
RUN apt-get install -y net-tools iptables
27+
RUN DEBIAN_FRONTEND=noninteractive apt-get install -y net-tools iptables
2928

3029
# Copy mock AWS CLI into the PATH
3130
COPY ./.circleci/aws-local.sh /usr/local/bin/aws
3231

33-
# These have been added to resolve some encoding error issues with the tests. These were introduced during the upgrade to Python 3.6,
34-
# which is known to have some sensitivity around locale issues. These variables should correct that, per examples like this SO thread:
32+
# These have been added to resolve some encoding error issues with the tests. These were introduced during the upgrade to Python 3.6,
33+
# which is known to have some sensitivity around locale issues. These variables should correct that, per examples like this SO thread:
3534
# https://stackoverflow.com/questions/51026315/how-to-solve-unicodedecodeerror-in-python-3-6/51027262#51027262.
3635
ENV LC_ALL=C.UTF-8
37-
ENV LANG=C.UTF-8
36+
ENV LANG=C.UTF-8

‎Dockerfile.ubuntu18.04.bats

+14-17
Original file line numberDiff line numberDiff line change
@@ -2,35 +2,32 @@ FROM ubuntu:18.04
22
MAINTAINER Gruntwork <[email protected]>
33

44
# Install basic dependencies
5-
RUN DEBIAN_FRONTEND=noninteractive apt-get update && \
6-
apt-get install -y vim python-pip jq sudo curl libffi-dev python3-dev
5+
RUN apt-get update && \
6+
DEBIAN_FRONTEND=noninteractive apt-get install -y git vim python3-pip jq sudo curl libffi-dev python3-dev
77

88
# Install Bats
9-
RUN apt-get install -y software-properties-common && \
10-
add-apt-repository ppa:duggan/bats && \
11-
DEBIAN_FRONTEND=noninteractive apt-get update && \
12-
apt-get install -y bats
9+
RUN git clone https://github.com/bats-core/bats-core.git /tmp/bats-core && \
10+
/tmp/bats-core/install.sh /usr/local && \
11+
rm -r /tmp/bats-core
12+
13+
# Upgrade pip
14+
RUN pip3 install -U pip
1315

1416
# Install AWS CLI
15-
RUN apt install python3-distutils python3-apt -y && \
16-
update-alternatives --install /usr/bin/python python /usr/bin/python3 1 && \
17-
update-alternatives --config python && \
18-
curl https://bootstrap.pypa.io/get-pip.py -o /tmp/get-pip.py && \
19-
python /tmp/get-pip.py && \
20-
pip install awscli --upgrade --user
17+
RUN pip3 install awscli --upgrade --user
2118

2219
# Install moto: https://github.com/spulec/moto
2320
# Lock cfn-lint and pysistent to last known working versions
24-
RUN pip install flask moto moto[server] cfn-lint==0.35.1 pyrsistent==0.16.0
21+
RUN pip3 install flask moto moto[server] cfn-lint==0.35.1 pyrsistent==0.16.0
2522

2623
# Install tools we'll need to create a mock EC2 metadata server
27-
RUN apt-get install -y net-tools iptables
24+
RUN DEBIAN_FRONTEND=noninteractive apt-get install -y net-tools iptables
2825

2926
# Copy mock AWS CLI into the PATH
3027
COPY ./.circleci/aws-local.sh /usr/local/bin/aws
3128

32-
# These have been added to resolve some encoding error issues with the tests. These were introduced during the upgrade to Python 3.6,
33-
# which is known to have some sensitivity around locale issues. These variables should correct that, per examples like this SO thread:
29+
# These have been added to resolve some encoding error issues with the tests. These were introduced during the upgrade to Python 3.6,
30+
# which is known to have some sensitivity around locale issues. These variables should correct that, per examples like this SO thread:
3431
# https://stackoverflow.com/questions/51026315/how-to-solve-unicodedecodeerror-in-python-3-6/51027262#51027262.
3532
ENV LC_ALL=C.UTF-8
36-
ENV LANG=C.UTF-8
33+
ENV LANG=C.UTF-8

‎Dockerfile.ubuntu20.04.bats

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
FROM ubuntu:20.04
2+
MAINTAINER Gruntwork <[email protected]>
3+
4+
# Install basic dependencies
5+
RUN apt-get update && \
6+
DEBIAN_FRONTEND=noninteractive apt-get install -y git vim python3-pip jq sudo curl libffi-dev python3-dev
7+
8+
# Install Bats
9+
RUN git clone https://github.com/bats-core/bats-core.git /tmp/bats-core && \
10+
/tmp/bats-core/install.sh /usr/local && \
11+
rm -r /tmp/bats-core
12+
13+
# Upgrade pip
14+
RUN pip3 install -U pip
15+
16+
# Install AWS CLI
17+
RUN pip3 install awscli --upgrade --user
18+
19+
# Install moto: https://github.com/spulec/moto
20+
# Lock cfn-lint and pysistent to last known working versions
21+
RUN pip3 install flask moto moto[server] cfn-lint==0.35.1 pyrsistent==0.16.0
22+
23+
# Install tools we'll need to create a mock EC2 metadata server
24+
RUN DEBIAN_FRONTEND=noninteractive apt-get install -y net-tools iptables
25+
26+
# Copy mock AWS CLI into the PATH
27+
COPY ./.circleci/aws-local.sh /usr/local/bin/aws
28+
29+
# These have been added to resolve some encoding error issues with the tests. These were introduced during the upgrade to Python 3.6,
30+
# which is known to have some sensitivity around locale issues. These variables should correct that, per examples like this SO thread:
31+
# https://stackoverflow.com/questions/51026315/how-to-solve-unicodedecodeerror-in-python-3-6/51027262#51027262.
32+
ENV LC_ALL=C.UTF-8
33+
ENV LANG=C.UTF-8

‎docker-compose.yml

+11
Original file line numberDiff line numberDiff line change
@@ -30,3 +30,14 @@ services:
3030
command: bats test
3131
# Necessary so we can run a mock EC2 metadata service on port 80 on a special IP
3232
privileged: true
33+
bats_ubuntu2004:
34+
build:
35+
context: ./
36+
dockerfile: Dockerfile.ubuntu20.04.bats
37+
volumes:
38+
# Mount all the files so you have "hot reload" of all changes from the host
39+
- ./:/usr/local/src/bash-commons
40+
working_dir: /usr/local/src/bash-commons
41+
command: bats test
42+
# Necessary so we can run a mock EC2 metadata service on port 80 on a special IP
43+
privileged: true

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ function os_create_user {
105105
log_info "User $username already exists. Will not create again."
106106
else
107107
log_info "Creating user named $username"
108-
"$exuseradd" "$username"
108+
$exuseradd "$username"
109109
fi
110110
}
111111

@@ -121,5 +121,5 @@ function os_change_dir_owner {
121121
fi
122122

123123
log_info "Changing ownership of $dir to $username"
124-
"$exchown" -R "$username:$username" "$dir"
124+
$exchown -R "$username:$username" "$dir"
125125
}

‎test/aws-cli.bats

+17-17
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ function teardown {
1616
run aws_get_instance_tags "fake-id" "us-east-1"
1717
assert_success
1818

19-
local readonly expected=$(cat <<END_HEREDOC
19+
local -r expected=$(cat <<END_HEREDOC
2020
{
2121
"Tags": []
2222
}
@@ -27,16 +27,16 @@ END_HEREDOC
2727
}
2828

2929
@test "aws_get_instance_tags non-empty" {
30-
local readonly tag_key="foo"
31-
local readonly tag_value="bar"
30+
local -r tag_key="foo"
31+
local -r tag_value="bar"
3232

3333
local instance_id
3434
instance_id=$(create_mock_instance_with_tags "$tag_key" "$tag_value")
3535

3636
run aws_get_instance_tags "$instance_id" "us-east-1"
3737
assert_success
3838

39-
local readonly expected=$(cat <<END_HEREDOC
39+
local -r expected=$(cat <<END_HEREDOC
4040
{
4141
"Tags": [
4242
{
@@ -72,7 +72,7 @@ END_HEREDOC
7272
run aws_describe_asg "fake-asg-name" "us-east-1"
7373
assert_success
7474

75-
local readonly expected=$(cat <<END_HEREDOC
75+
local -r expected=$(cat <<END_HEREDOC
7676
{
7777
"AutoScalingGroups": []
7878
}
@@ -83,11 +83,11 @@ END_HEREDOC
8383
}
8484

8585
@test "aws_describe_asg non-empty" {
86-
local readonly asg_name="foo"
87-
local readonly min_size=1
88-
local readonly max_size=3
89-
local readonly region="us-east-1"
90-
local readonly azs="${region}a"
86+
local -r asg_name="foo"
87+
local -r min_size=1
88+
local -r max_size=3
89+
local -r region="us-east-1"
90+
local -r azs="${region}a"
9191

9292
create_mock_asg "$asg_name" "$min_size" "$max_size" "$azs"
9393

@@ -111,7 +111,7 @@ END_HEREDOC
111111
run aws_describe_instances_in_asg "fake-asg-name" "us-east-1"
112112
assert_success
113113

114-
local readonly expected=$(cat <<END_HEREDOC
114+
local -r expected=$(cat <<END_HEREDOC
115115
{
116116
"Reservations": []
117117
}
@@ -122,11 +122,11 @@ END_HEREDOC
122122
}
123123

124124
@test "aws_describe_instances_in_asg non-empty" {
125-
local readonly asg_name="foo"
126-
local readonly min_size=1
127-
local readonly max_size=3
128-
local readonly region="us-east-1"
129-
local readonly azs="${region}a"
125+
local -r asg_name="foo"
126+
local -r min_size=1
127+
local -r max_size=3
128+
local -r region="us-east-1"
129+
local -r azs="${region}a"
130130

131131
create_mock_asg "$asg_name" "$min_size" "$max_size" "$azs"
132132

@@ -142,7 +142,7 @@ END_HEREDOC
142142
run aws_get_instances_with_tag "Name" "Value" "us-east-1"
143143
assert_success
144144

145-
local readonly expected=$(cat <<END_HEREDOC
145+
local -r expected=$(cat <<END_HEREDOC
146146
{
147147
"Reservations": []
148148
}

‎test/aws-helper.bash

+11-11
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ function start_ec2_metadata_mock {
1919
export meta_data_local_hostname="$3"
2020
export meta_data_public_hostname="$4"
2121
export meta_data_instance_id="$5"
22-
local readonly region="$6"
22+
local -r region="$6"
2323
export meta_data_placement__availability_zone="$7"
2424
export dynamic_data_instance_identity__document=$(cat <<END_HEREDOC
2525
{
@@ -71,7 +71,7 @@ END_HEREDOC
7171
function stop_ec2_metadata_mock {
7272
# Stop ec2-metadata-mock if it's running
7373
if [[ -f "$EC2_METADATA_MOCK_PID_PATH" ]]; then
74-
local readonly pid=$(cat "$EC2_METADATA_MOCK_PID_PATH")
74+
local -r pid=$(cat "$EC2_METADATA_MOCK_PID_PATH")
7575
kill "$pid" 2>&1 > "$EC2_METADATA_MOCK_LOG_FILE_PATH"
7676
rm -f "$EC2_METADATA_MOCK_PID_PATH"
7777

@@ -108,7 +108,7 @@ function start_moto {
108108
function stop_moto {
109109
# Stop moto if it's running
110110
if [[ -f "$MOTO_PID_FILE_PATH" ]]; then
111-
local readonly pid=$(cat "$MOTO_PID_FILE_PATH")
111+
local -r pid=$(cat "$MOTO_PID_FILE_PATH")
112112
kill "$pid" 2>&1 > /dev/null
113113
rm -f "$MOTO_PID_FILE_PATH"
114114

@@ -118,8 +118,8 @@ function stop_moto {
118118
}
119119

120120
function create_mock_instance_with_tags {
121-
local readonly tag_key="$1"
122-
local readonly tag_value="$2"
121+
local -r tag_key="$1"
122+
local -r tag_value="$2"
123123

124124
local mock_instance
125125
mock_instance=$(aws ec2 run-instances)
@@ -133,11 +133,11 @@ function create_mock_instance_with_tags {
133133
}
134134

135135
function create_mock_asg {
136-
local readonly asg_name="$1"
137-
local readonly min_size="$2"
138-
local readonly max_size="$3"
139-
local readonly azs="$4"
136+
local -r asg_name="$1"
137+
local -r min_size="$2"
138+
local -r max_size="$3"
139+
local -r azs="$4"
140140

141-
aws autoscaling create-launch-configuration --launch-configuration-name "$asg_name"
141+
aws autoscaling create-launch-configuration --launch-configuration-name "$asg_name" --image-id ami-fake --instance-type t3.micro
142142
aws autoscaling create-auto-scaling-group --auto-scaling-group-name "$asg_name" --min-size "$min_size" --max-size "$max_size" --availability-zones "$azs" --launch-configuration-name "$asg_name"
143-
}
143+
}

‎test/aws-wrapper.bats

+2-20
Original file line numberDiff line numberDiff line change
@@ -255,25 +255,7 @@ END_HEREDOC
255255

256256
load_aws_mock "$tags" "" ""
257257

258-
run naws_wrapper_wait_for_instance_tags "i-1234567890abcdef0" "us-east-1" "$max_retries" "$sleep_between_retries"
259-
260-
assert_failure
261-
}
262-
263-
@test "aws_wrapper_wait_for_instance_tags no tags" {
264-
local reaodnly max_retries=1
265-
local readonly sleep_between_retries=0
266-
local readonly tags=$(cat <<END_HEREDOC
267-
{
268-
"Tags": []
269-
}
270-
END_HEREDOC
271-
)
272-
273-
load_aws_mock "$tags" "" ""
274-
275-
run naws_wrapper_wait_for_instance_tags "i-1234567890abcdef0" "us-east-1" "$max_retries" "$sleep_between_retries"
276-
258+
run aws_wrapper_wait_for_instance_tags "i-1234567890abcdef0" "us-east-1" "$max_retries" "$sleep_between_retries"
277259
assert_failure
278260
}
279261

@@ -1596,4 +1578,4 @@ END_HEREDOC
15961578

15971579
run aws_wrapper_get_asg_rally_point $asg_name $aws_region $use_public_hostname $retries $sleep_between_retries
15981580
assert_failure
1599-
}
1581+
}

0 commit comments

Comments
 (0)