fix: correct shell script format via shellcheck reports #1447

zhuangqh · 2018-05-31T11:52:13Z

Ⅰ. Describe what this PR did

This PR help pouch to pass the ShellCheck (https://github.com/koalaman/shellcheck). There is a short report.

SC2086 Double quote to prevent globbing and word splitting 94 fail(s)
SC2046 Quote this to prevent word splitting 8 fail(s)
SC2034 POUCH_SOCK appears unused. Verify it or export it 7 fail(s)
SC2039 In POSIX sh, 'pushd' is not supported 6 fail(s)
SC2148 Tips depend on target shell and yours is unknown. Add a shebang 5 fail(s)
SC2112 'function' keyword is non-standard. Delete it 4 fail(s)
SC2016 Expressions don't expand in single quotes, use double quotes for that 3 fail(s)
SC2006 Use $(..) instead of legacy .. 2 fail(s)
SC2129 Consider using { cmd1; cmd2; } >> file instead of individual redirects 1 fail(s)
SC2071 < is for string comparisons. Use -lt instead 1 fail(s)
SC2068 Double quote array expansions, otherwise they're like $* and break on spaces 1 fail(s)
SC2064 Use single quotes, otherwise this expands now rather than when signalled 1 fail(s)

You can find the detailed rules here

Ⅱ. Does this pull request fix one issue?

Ⅲ. Describe how you did it

Ⅳ. Describe how to verify it

ShellCheck don't report error.

find ./ -name "*.sh" | grep -v vendor | grep -v extra | xargs shellcheck

Shell script still works fine.

Ⅴ. Special notes for reviews

In rule SC2086

When quoting composite arguments, make sure to exclude globs and brace expansions, which lose their special meaning in double quotes: "$HOME/$dir/src/*.c" will not expand, but "$HOME/$dir/src"/*.c will.

Signed-off-by: Allen Sun <allensun.shl@alibaba-inc.com>

Signed-off-by: zhuangqh <zhuangqhc@163.com>

fuweid · 2018-05-31T11:53:06Z

Nice!

zhuangqh · 2018-05-31T11:55:31Z

related to #1437

codecov-io · 2018-05-31T12:16:24Z

Codecov Report

Merging #1447 into master will increase coverage by 21.24%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master   #1447       +/-   ##
==========================================
+ Coverage   16.26%   37.5%   +21.24%     
==========================================
  Files         206     254       +48     
  Lines       13759   17368     +3609     
==========================================
+ Hits         2238    6514     +4276     
+ Misses      11365   10023     -1342     
- Partials      156     831      +675

Impacted Files	Coverage Δ
cli/main.go	`0% <0%> (ø)`	⬆️
client/container_wait.go
cli/wait.go
cri/stream/errors.go	`0% <0%> (ø)`
cri/stream/httpstream/httpstream.go	`0% <0%> (ø)`
storage/volume/error/errors.go	`28.57% <0%> (ø)`
pkg/system/os.go	`75% <0%> (ø)`
cri/stream/remotecommand/httpstream.go	`0% <0%> (ø)`
cri/stream/httpstream/spdy/connection.go	`0% <0%> (ø)`
storage/volume/modules/local/local.go	`68.57% <0%> (ø)`
... and 115 more

allencloud · 2018-05-31T12:22:59Z

hack/package/rpm/build.sh

          --description 'Pouch is an open-source project created by Alibaba Group to promote the container technology movement.

-    Pouchs vision is to advance container ecosystem and promote container standards OCI, so that container technologies become the foundation for application development in the Cloud era.
+    Pouch'"'"'s vision is to advance container ecosystem and promote container standards OCI, so that container technologies become the foundation for application development in the Cloud era.


I do not think this change is correct.

This change aims to display single quote correctly. @allencloud
related link: https://stackoverflow.com/questions/1250079/how-to-escape-single-quotes-within-single-quoted-strings

Oh, I see. This is not just doc, but a string in shell script. My fault.

allencloud · 2018-05-31T13:36:52Z

hack/make.sh

-		tar xf $TMP/containerd-1.0.3.linux-amd64.tar.gz -C $TMP &&
-			cp -f $TMP/bin/* /usr/local/bin/
+			https://github.com/containerd/containerd/releases/download/v1.0.3/containerd-1.0.3.linux-amd64.tar.gz -P "$TMP"
+		tar xf "$TMP/containerd-1.0.3.linux-amd64.tar.gz" -C "$TMP" &&


I think in the future we need to make this version configurable at the head of this file rather than hard coding here. And all the 1.0.3 things should use the variable.

allencloud · 2018-05-31T13:42:24Z

hack/package/rpm/build.sh

@@ -48,19 +47,19 @@ function build_pouch()
 {
    # install containerd
    echo "Downloading containerd."
-    wget --quiet https://github.com/containerd/containerd/releases/download/v1.0.3/containerd-1.0.3.linux-amd64.tar.gz -P $TMP
-    tar xf $TMP/containerd-1.0.3.linux-amd64.tar.gz -C $TMP && cp -f $TMP/bin/* $BINDIR/
+    wget --quiet https://github.com/containerd/containerd/releases/download/v1.0.3/containerd-1.0.3.linux-amd64.tar.gz -P "$TMP"


Also this place, there is hard coding

allencloud · 2018-05-31T13:42:52Z

hack/package/rpm/build.sh

-    wget --quiet https://github.com/alibaba/runc/releases/download/v1.0.0-rc4-1/runc.amd64 -P $BINDIR/
-    chmod +x $BINDIR/runc.amd64
-    mv $BINDIR/runc.amd64 $BINDIR/runc
+    wget --quiet https://github.com/alibaba/runc/releases/download/v1.0.0-rc4-1/runc.amd64 -P "$BINDIR/"


also here, hard coding

allencloud · 2018-05-31T13:44:14Z

LGTM since I take a quick review of this. However, I still wish to invite @ZouRui89 to take a thorough review of this. Thanks a lot.

zhuangqh · 2018-06-01T14:12:23Z

hack/package/rpm/build.sh

-    wget --quiet https://github.com/containerd/containerd/releases/download/v1.0.3/containerd-1.0.3.linux-amd64.tar.gz -P $TMP
-    tar xf $TMP/containerd-1.0.3.linux-amd64.tar.gz -C $TMP && cp -f $TMP/bin/* $BINDIR/
+    wget --quiet https://github.com/containerd/containerd/releases/download/v1.0.3/containerd-1.0.3.linux-amd64.tar.gz -P "$TMP"
+    tar xf "$TMP/containerd-1.0.3.linux-amd64.tar.gz -C $TMP && cp -f $TMP/bin/* $BINDIR/"


There should double quote one by one, or won't work.😅

I will fix this in another PR, together with the problem of hardcode.

@zhuangqh cool!

allencloud and others added 2 commits May 31, 2018 17:38

feature: add shellcheck to validate shell script

b4149ce

Signed-off-by: Allen Sun <allensun.shl@alibaba-inc.com>

fix: correct shell script format via shellcheck reports

96f0609

Signed-off-by: zhuangqh <zhuangqhc@163.com>

pouchrobot added kind/bug This is bug report for project size/XL labels May 31, 2018

zhuangqh mentioned this pull request May 31, 2018

feature: add shellcheck to validate shell script #1437

Closed

allencloud reviewed May 31, 2018

View reviewed changes

pouchrobot added the LGTM one maintainer or community participant agrees to merge the pull reuqest. label May 31, 2018

allencloud merged commit 74e5ac7 into AliyunContainerService:master Jun 1, 2018

zhuangqh commented Jun 1, 2018

View reviewed changes

zhuangqh mentioned this pull request Jun 1, 2018

refactor: correct hard coding in several shell script #1452

Merged

pouchrobot mentioned this pull request Jun 7, 2018

Weekly Report of Pouch from 2018-05-31 to 2018-06-07 #1482

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: correct shell script format via shellcheck reports #1447

fix: correct shell script format via shellcheck reports #1447

zhuangqh commented May 31, 2018

fuweid commented May 31, 2018

zhuangqh commented May 31, 2018

codecov-io commented May 31, 2018

allencloud May 31, 2018

zhuangqh May 31, 2018 •

edited

Loading

allencloud May 31, 2018

allencloud May 31, 2018 •

edited

Loading

allencloud May 31, 2018

allencloud May 31, 2018

allencloud commented May 31, 2018

zhuangqh Jun 1, 2018

zhuangqh Jun 1, 2018

fuweid Jun 1, 2018

fix: correct shell script format via shellcheck reports #1447

fix: correct shell script format via shellcheck reports #1447

Conversation

zhuangqh commented May 31, 2018

Ⅰ. Describe what this PR did

Ⅱ. Does this pull request fix one issue?

Ⅲ. Describe how you did it

Ⅳ. Describe how to verify it

Ⅴ. Special notes for reviews

fuweid commented May 31, 2018

zhuangqh commented May 31, 2018

codecov-io commented May 31, 2018

Codecov Report

allencloud May 31, 2018

Choose a reason for hiding this comment

zhuangqh May 31, 2018 • edited Loading

Choose a reason for hiding this comment

allencloud May 31, 2018

Choose a reason for hiding this comment

allencloud May 31, 2018 • edited Loading

Choose a reason for hiding this comment

allencloud May 31, 2018

Choose a reason for hiding this comment

allencloud May 31, 2018

Choose a reason for hiding this comment

allencloud commented May 31, 2018

zhuangqh Jun 1, 2018

Choose a reason for hiding this comment

zhuangqh Jun 1, 2018

Choose a reason for hiding this comment

fuweid Jun 1, 2018

Choose a reason for hiding this comment

zhuangqh May 31, 2018 •

edited

Loading

allencloud May 31, 2018 •

edited

Loading