Merge pull request #135 from nao1215/chore/update-test-and-doc

Update README and unit test

.all-contributorsrc

@@ -78,6 +78,15 @@
       "contributions": [
         "code"
       ]
+    },
+    {
+      "login": "rkscv",
+      "name": "rkscv",
+      "avatar_url": "https://avatars.githubusercontent.com/u/155284493?v=4",
+      "profile": "https://github.com/rkscv",
+      "contributions": [
+        "code"
+      ]
     }
   ],
   "contributorsPerLine": 7,

README.md

@@ -1,5 +1,5 @@
 <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
-[![All Contributors](https://img.shields.io/badge/all_contributors-8-orange.svg?style=flat-square)](#contributors-)
+[![All Contributors](https://img.shields.io/badge/all_contributors-9-orange.svg?style=flat-square)](#contributors-)
 <!-- ALL-CONTRIBUTORS-BADGE:END -->
 [![Mentioned in Awesome Go](https://awesome.re/mentioned-badge.svg)](https://github.com/avelino/awesome-go)
 [![MultiVersionUnitTest](https://github.com/nao1215/gup/actions/workflows/multi_ver_unittest.yml/badge.svg)](https://github.com/nao1215/gup/actions/workflows/multi_ver_unittest.yml)
@@ -233,6 +233,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
     </tr>
     <tr>
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/Akimon658"><img src="https://avatars.githubusercontent.com/u/81888693?v=4?s=100" width="100px;" alt="Akimo"/><br /><sub><b>Akimo</b></sub></a><br /><a href="https://github.com/nao1215/gup/commits?author=Akimon658" title="Code">💻</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/rkscv"><img src="https://avatars.githubusercontent.com/u/155284493?v=4?s=100" width="100px;" alt="rkscv"/><br /><sub><b>rkscv</b></sub></a><br /><a href="https://github.com/nao1215/gup/commits?author=rkscv" title="Code">💻</a></td>
     </tr>
   </tbody>
 </table>

cmd/bug_report.go

@@ -15,12 +15,16 @@ func newBugReportCmd() *cobra.Command {
 		Long:    "bug-report opens the default browser to start a bug report which will include useful system information.",
 		Example: "   gup bug-report",
 		Run: func(cmd *cobra.Command, args []string) {
-			OsExit(bugReport(cmd, args))
+			OsExit(bugReport(cmd, args, openBrowser))
 		},
 	}
 }
 
-func bugReport(cmd *cobra.Command, args []string) int { //nolint
+// openBrowserFunc is a function that opens a browser to the specified URL.
+type openBrowserFunc func(string) bool
+
+// bugReport opens the default browser to start a bug report which will include useful system information.
+func bugReport(cmd *cobra.Command, _ []string, openBrowser openBrowserFunc) int { //nolint
 	var buf bytes.Buffer
 
 	const (

cmd/bug_report_linux_test.go

@@ -0,0 +1,20 @@
+//go:build linux
+
+package cmd
+
+import (
+	"runtime"
+	"testing"
+)
+
+func Test_openBrowser(t *testing.T) {
+	t.Parallel()
+	if runtime.GOOS != "linux" {
+		t.Skip("skipping test on non-linux system")
+	}
+
+	got := openBrowser("https://example.com")
+	if !got {
+		t.Error("openBrowser() = false; want true")
+	}
+}

cmd/bug_report_test.go

@@ -44,3 +44,21 @@ func TestBugReport(t *testing.T) {
 		}
 	})
 }
+
+func Test_bugReport(t *testing.T) {
+	t.Parallel()
+
+	cmd := newBugReportCmd()
+	cmd.Version = "v0.0.0"
+
+	wantReturnVal := 0
+	gotReturnVal := bugReport(cmd, nil, func(s string) bool {
+		if !strings.Contains(s, "v0.0.0") {
+			t.Errorf("Expected bug report to contain version number 'v0.0.0', but got: %s", s)
+		}
+		return true
+	})
+	if gotReturnVal != wantReturnVal {
+		t.Errorf("bugReport() = %d; want %d", gotReturnVal, wantReturnVal)
+	}
+}