Add --format to docker-search #440

boaz0 · 2017-08-15T11:08:56Z

- What I did

This is a follow-up to Jeremy's PR moby/moby#31539.

This patch adds the format flag to the docker search command and by that completes moby/moby#30431.

Signed-off-by: Jeremy Chambers jeremy@thehipbot.com
Signed-off-by: Boaz Shuster ripcurld.github@gmail.com

- How I did it

Created cli/command/formatter/search.go and cli/command/formatter/search_test.go
Updated cli/command/registry/search.go and docs/reference/commandline/search.md

- How to verify it

Run unit tests

- Description for the changelog

Add format to docker search

- A picture of a cute animal (not mandatory but encouraged)

mdlinville · 2017-08-15T21:51:33Z

docs/reference/commandline/search.md

+
+### Format the output
+
+The formatting option (`--format`) will pretty print search output


pretty-print

mdlinville · 2017-08-15T21:51:50Z

docs/reference/commandline/search.md

+The formatting option (`--format`) will pretty print search output
+using a Go template.
+
+Valid placeholders for the Go template are listed below:


s/are listed below:/are:

mdlinville · 2017-08-15T21:52:20Z

docs/reference/commandline/search.md

+| `.IsOfficial`  | "OK" if image is official         |
+| `.IsAutomated` | "OK" if image build was automated |
+
+When using the `--format` option, the `search` command will either


s/when using/when you use

mdlinville · 2017-08-15T21:52:43Z

docs/reference/commandline/search.md

+| `.IsAutomated` | "OK" if image build was automated |
+
+When using the `--format` option, the `search` command will either
+output the data exactly as the template declares or, when using the


declares. If you use the `table directive, column headers are included as well.

mdlinville · 2017-08-15T21:53:21Z

docs/reference/commandline/search.md

+{% endraw %}
+```
+
+To search for images in a table format youcan use:


This example outputs a table format:

vdemeester

LGTM 🐸

codecov-io · 2017-08-22T13:45:29Z

Codecov Report

Merging #440 into master will decrease coverage by 0.2%.
The diff coverage is 96.36%.

@@            Coverage Diff             @@
##           master     #440      +/-   ##
==========================================
- Coverage   47.04%   46.84%   -0.21%     
==========================================
  Files         198      198              
  Lines       16349    16339      -10     
==========================================
- Hits         7692     7654      -38     
- Misses       8262     8295      +33     
+ Partials      395      390       -5

dnephin

Thanks! LGTM

some minor comments, but nothing blocking merge

dnephin · 2017-08-22T17:41:14Z

cli/command/registry/search.go

+	format := options.format
+	if len(format) == 0 {
+		format = formatter.TableFormatKey
+	}


minor: we could handle this default is formatter.NewSearchFormat()

dnephin · 2017-08-22T17:47:45Z

cli/command/formatter/search.go

+		}
+	}
+	return official
+}


Minor, a function could be used to remove the duplication in IsOfficial() and IsAutomated()

func (c *searchContext) formatBool(value bool) string { switch { case value && c.json: return "true" case value: return "[OK]" case c.json: return "false" } return "" }

dnephin · 2017-08-22T17:49:41Z

cli/command/formatter/search_test.go

+	}
+}
+
+func TestSearchContext_Description(t *testing.T) {


Minor: usually there are no underscores in test names: TestSearchContextDescription

boaz0 · 2017-08-22T21:37:25Z

@dnephin no problemo

dnephin · 2017-08-22T21:42:59Z

@mstanleyjones docs looks good now?

mdlinville

Approved with one teensy little suggestion for improvement. Thanks! 🙌

mdlinville · 2017-08-22T22:03:23Z

docs/reference/commandline/search.md

+
+### Format the output
+
+The formatting option (`--format`) will pretty-print search output


s/will pretty-print/pretty-prints

boaz0 · 2017-08-22T22:19:53Z

@mstanleyjones done! thanks for your review 👍 🍡

mdlinville · 2017-08-22T22:34:19Z

GMail renders that 🍡 as a radish!

mdlinville · 2017-08-22T22:35:16Z

docs/reference/commandline/search.md

+
+### Format the output
+
+The formatting option (`--format`) will pretty-prints search output


I think you forgot to take out the word "will" here.

Signed-off-by: Jeremy Chambers <jeremy@thehipbot.com> Signed-off-by: Boaz Shuster <ripcurld.github@gmail.com>

boaz0 · 2017-08-22T22:38:49Z

@mstanleyjones ☕️

mdlinville

🍦

boaz0 requested review from mdlinville, thaJeztah and vdemeester as code owners August 15, 2017 11:08

GordonTheTurtle added the status/0-triage label Aug 15, 2017

mdlinville suggested changes Aug 15, 2017

View reviewed changes

thaJeztah added status/1-design-review and removed status/0-triage labels Aug 16, 2017

vdemeester approved these changes Aug 22, 2017

View reviewed changes

vdemeester added status/2-code-review and removed status/1-design-review labels Aug 22, 2017

dnephin approved these changes Aug 22, 2017

View reviewed changes

dnephin added status/3-docs-review and removed status/2-code-review labels Aug 22, 2017

mdlinville approved these changes Aug 22, 2017

View reviewed changes

dnephin added status/4-merge and removed status/3-docs-review labels Aug 22, 2017

mdlinville suggested changes Aug 22, 2017

View reviewed changes

Add --format to docker-search

88cc47a

Signed-off-by: Jeremy Chambers <jeremy@thehipbot.com> Signed-off-by: Boaz Shuster <ripcurld.github@gmail.com>

mdlinville approved these changes Aug 22, 2017

View reviewed changes

dnephin merged commit 05308fc into docker:master Aug 22, 2017

GordonTheTurtle added this to the 17.08.0 milestone Aug 22, 2017

albers mentioned this pull request Sep 4, 2017

Add bash completion for search --format #504

Merged

thaJeztah added the impact/changelog label Sep 26, 2017

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add --format to docker-search #440

Add --format to docker-search #440

boaz0 commented Aug 15, 2017

mdlinville Aug 15, 2017

mdlinville Aug 15, 2017

mdlinville Aug 15, 2017

mdlinville Aug 15, 2017

mdlinville Aug 15, 2017

vdemeester left a comment

codecov-io commented Aug 22, 2017 •

edited

Loading

dnephin left a comment

dnephin Aug 22, 2017

dnephin Aug 22, 2017

dnephin Aug 22, 2017

boaz0 commented Aug 22, 2017

dnephin commented Aug 22, 2017

mdlinville left a comment

mdlinville Aug 22, 2017

boaz0 commented Aug 22, 2017

mdlinville commented Aug 22, 2017

mdlinville Aug 22, 2017

boaz0 commented Aug 22, 2017 •

edited

Loading

mdlinville left a comment


		### Format the output

		The formatting option (`--format`) will pretty print search output

Add --format to docker-search #440

Add --format to docker-search #440

Conversation

boaz0 commented Aug 15, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vdemeester left a comment

Choose a reason for hiding this comment

codecov-io commented Aug 22, 2017 • edited Loading

Codecov Report

dnephin left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

boaz0 commented Aug 22, 2017

dnephin commented Aug 22, 2017

mdlinville left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

boaz0 commented Aug 22, 2017

mdlinville commented Aug 22, 2017

Choose a reason for hiding this comment

boaz0 commented Aug 22, 2017 • edited Loading

mdlinville left a comment

Choose a reason for hiding this comment

codecov-io commented Aug 22, 2017 •

edited

Loading

boaz0 commented Aug 22, 2017 •

edited

Loading