Add unit test for goutil package #41

KEINOS · 2022-09-17T00:23:14Z

This PR will cover the gup/internal/goutil.

Add initial test to draft a PR
Add examples for public functions in goutil package to cover the basics
Add examples for public methods
Add tests for failed/error cases
Apply dependency injection to enable mock/monkey-patch
cover gouil up to 100%

codecov · 2022-09-17T00:24:31Z

Codecov Report

Merging #41 (8476fb6) into main (6c7cc49) will increase coverage by 3.40%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##             main      #41      +/-   ##
==========================================
+ Coverage   84.40%   87.81%   +3.40%     
==========================================
  Files          10       11       +1     
  Lines         295      435     +140     
==========================================
+ Hits          249      382     +133     
- Misses         33       39       +6     
- Partials       13       14       +1

Impacted Files	Coverage Δ
internal/goutil/goutil.go	`95.00% <100.00%> (ø)`

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

nao1215 · 2022-09-17T02:12:58Z

@KEINOS
Your way of making unit tests is more careful than mine. Perhaps I will be satisfied enough with the tests you write in the future.

cover gouil up to 100%

You don't have to force yourself to aim for 100% coverage.
Coverage of 80% or more is sufficient.

KEINOS · 2022-09-18T12:55:41Z

@nao1215

I think it's ready! 👍 Please review it when you got time 🤞

nao1215 · 2022-09-18T17:10:12Z

@KEINOS
LGTM.
However, I do not know if the test will work on Windows.
Please merge the code from the main branch when you have time 🙏

Currently, the test passes on Linux, Mac, and Windows.
However, Mac and Windows may fail the test in rare cases due to bad race condition.
(There is a problem with the unit test I wrote)

KEINOS · 2022-09-19T00:50:52Z

Windows...

nao1215 · 2022-09-19T00:51:05Z

Windows...

KEINOS · 2022-09-19T01:08:59Z

@nao1215

It seems the errors are from gup/internal/slice tests and not from goutils.

Is it OK to touch them?

Though, I don't know why it fails on Windows. It seems ok at the first glance.

KEINOS · 2022-09-19T01:50:25Z

@nao1215

Sorry, I was wrong about the above comment. It IS my bad.

https://github.com/nao1215/gup/actions/runs/3079250233/jobs/4975350665#step:4:253

nao1215 · 2022-09-19T02:30:25Z

@KEINOS
You need to fix "--- FAIL" ar "Run unit test" result.
Windows has a different separator for file paths, so the hard-coded paths must be replaced with filepath.Join().

KEINOS · 2022-09-19T04:43:23Z

Windows has a different separator for file paths

Linux「Windows...」
macOS「Windows...」
UNIX「Indeed」

KEINOS · 2022-09-19T06:52:31Z

[MEMO]: Differences of module paths between platforms

macOS

$ go version -m "$(which gup)"
/Users/admin/go/bin/gup: go1.19.1
        path    github.com/nao1215/gup
        mod     github.com/nao1215/gup  v0.10.5 h1:kQKlfrQyNIBq4DlOKB26oLOFHStszgxSnTKyOtdMJbM=
        dep     github.com/fatih/color  v1.13.0 h1:8LOYc1KYPPmyKMuN8QV2DNRWNbLo6LZ0iLs8+mlH53w=
        dep     github.com/gen2brain/beeep      v0.0.0-20210529141713-5586760f0cc1      h1:Xh9mvwEmhbdXlRSsgn+N0zj/NqnKvpeqL08oKDHln2s=
        dep     github.com/mattn/go-colorable   v0.1.12 h1:jF+Du6AlPIjs2BiUiQlKOX0rt3SujHxPnksPKZbaA40=
        dep     github.com/mattn/go-isatty      v0.0.14 h1:yVuAays6BHfxijgZPzw+3Zlu5yQgKGP2/hcQbHb7S9Y=
        dep     github.com/spf13/cobra  v1.5.0  h1:X+jTBEBqF0bHN+9cSMgmfuvv2VHJ9ezmFNf9Y/XstYU=
        dep     github.com/spf13/pflag  v1.0.5  h1:iy+VFUOCP1a+8yFto/drg2CJ5u0yRoB7fZw3DKv/JXA=
        dep     golang.org/x/sys        v0.0.0-20220412211240-33da011f77ad      h1:ntjMns5wyP/fN65tdBD4g8J5w8n015+iIIs9rtjXkY0=
        build   -compiler=gc
        build   CGO_ENABLED=1
        build   CGO_CFLAGS=
        build   CGO_CPPFLAGS=
        build   CGO_CXXFLAGS=
        build   CGO_LDFLAGS=
        build   GOARCH=amd64
        build   GOOS=darwin
        build   GOAMD64=v1

Linux (Debian, Docker+`golang:latest`)

# go version -m "$(which gup)"
/go/bin/gup: go1.19.1
        path    github.com/nao1215/gup
        mod     github.com/nao1215/gup  v0.10.5 h1:kQKlfrQyNIBq4DlOKB26oLOFHStszgxSnTKyOtdMJbM=
        dep     github.com/fatih/color  v1.13.0 h1:8LOYc1KYPPmyKMuN8QV2DNRWNbLo6LZ0iLs8+mlH53w=
        dep     github.com/gen2brain/beeep      v0.0.0-20210529141713-5586760f0cc1      h1:Xh9mvwEmhbdXlRSsgn+N0zj/NqnKvpeqL08oKDHln2s=
        dep     github.com/godbus/dbus/v5       v5.0.3  h1:ZqHaoEF7TBzh4jzPmqVhE/5A1z9of6orkAe5uHoAeME=
        dep     github.com/mattn/go-colorable   v0.1.12 h1:jF+Du6AlPIjs2BiUiQlKOX0rt3SujHxPnksPKZbaA40=
        dep     github.com/mattn/go-isatty      v0.0.14 h1:yVuAays6BHfxijgZPzw+3Zlu5yQgKGP2/hcQbHb7S9Y=
        dep     github.com/spf13/cobra  v1.5.0  h1:X+jTBEBqF0bHN+9cSMgmfuvv2VHJ9ezmFNf9Y/XstYU=
        dep     github.com/spf13/pflag  v1.0.5  h1:iy+VFUOCP1a+8yFto/drg2CJ5u0yRoB7fZw3DKv/JXA=
        dep     golang.org/x/sys        v0.0.0-20220412211240-33da011f77ad      h1:ntjMns5wyP/fN65tdBD4g8J5w8n015+iIIs9rtjXkY0=
        build   -compiler=gc
        build   CGO_ENABLED=1
        build   CGO_CFLAGS=
        build   CGO_CPPFLAGS=
        build   CGO_CXXFLAGS=
        build   CGO_LDFLAGS=
        build   GOARCH=amd64
        build   GOOS=linux
        build   GOAMD64=v1

Windows

>where gup
C:\Users\micro\go\bin\gup.exe

>go version -m "C:\Users\micro\go\bin\gup.exe"
C:\Users\micro\go\bin\gup.exe: go1.19.1
        path    github.com/nao1215/gup
        mod     github.com/nao1215/gup  v0.10.5 h1:kQKlfrQyNIBq4DlOKB26oLOFHStszgxSnTKyOtdMJbM=
        dep     github.com/fatih/color  v1.13.0 h1:8LOYc1KYPPmyKMuN8QV2DNRWNbLo6LZ0iLs8+mlH53w=
        dep     github.com/gen2brain/beeep      v0.0.0-20210529141713-5586760f0cc1      h1:Xh9mvwEmhbdXlRSsgn+N0zj/NqnKvpeqL08oKDHln2s=
        dep     github.com/go-toast/toast       v0.0.0-20190211030409-01e6764cf0a4      h1:qZNfIGkIANxGv/OqtnntR4DfOY2+BgwR60cAcu/i3SE=
        dep     github.com/inconshreveable/mousetrap    v1.0.0  h1:Z8tu5sraLXCXIcARxBp/8cbvlwVa7Z1NHg9XEKhtSvM=
        dep     github.com/mattn/go-colorable   v0.1.12 h1:jF+Du6AlPIjs2BiUiQlKOX0rt3SujHxPnksPKZbaA40=
        dep     github.com/mattn/go-isatty      v0.0.14 h1:yVuAays6BHfxijgZPzw+3Zlu5yQgKGP2/hcQbHb7S9Y=
        dep     github.com/nu7hatch/gouuid      v0.0.0-20131221200532-179d4d0c4d8d      h1:VhgPp6v9qf9Agr/56bj7Y/xa04UccTW04VP0Qed4vnQ=
        dep     github.com/spf13/cobra  v1.5.0  h1:X+jTBEBqF0bHN+9cSMgmfuvv2VHJ9ezmFNf9Y/XstYU=
        dep     github.com/spf13/pflag  v1.0.5  h1:iy+VFUOCP1a+8yFto/drg2CJ5u0yRoB7fZw3DKv/JXA=
        dep     github.com/tadvi/systray        v0.0.0-20190226123456-11a2b8fa57af      h1:6yITBqGTE2lEeTPG04SN9W+iWHCRyHqlVYILiSXziwk=
        dep     golang.org/x/sys        v0.0.0-20220412211240-33da011f77ad      h1:ntjMns5wyP/fN65tdBD4g8J5w8n015+iIIs9rtjXkY0=
        build   -compiler=gc
        build   CGO_ENABLED=1
        build   CGO_CFLAGS=
        build   CGO_CPPFLAGS=
        build   CGO_CXXFLAGS=
        build   CGO_LDFLAGS=
        build   GOARCH=amd64
        build   GOOS=windows
        build   GOAMD64=v1

- Avoid to check OS dependent error message (wrap them with custom message). - Avoid use of OS dependent directory separator.

nao1215 · 2022-09-19T07:09:58Z

@KEINOS
Excellent, the test passed!! You are now friends with Windows.
The test I made seems to fail frequently. I will fix it next time.

KEINOS force-pushed the fix-add-tests-for-goutil branch 2 times, most recently from 078131d to c4a15a7 Compare September 17, 2022 03:09

KEINOS changed the title ~~chore: add tests for goutil~~ Add unit test for goutil package Sep 17, 2022

KEINOS force-pushed the fix-add-tests-for-goutil branch 2 times, most recently from b482506 to d383f07 Compare September 18, 2022 12:50

KEINOS marked this pull request as ready for review September 18, 2022 12:53

nao1215 mentioned this pull request Sep 19, 2022

[Do not merge] fix add tests for goutil #47

Closed

KEINOS added 4 commits September 19, 2022 09:44

chore: add tests for goutil - IsAlreadyUpToDate()

2c9e8a3

chore: add examples as the basic tests

c8ee421

chore: add examples of public methods

6455870

Add unit test for goutil package

797b4bd

KEINOS force-pushed the fix-add-tests-for-goutil branch from d383f07 to 797b4bd Compare September 19, 2022 00:44

KEINOS force-pushed the fix-add-tests-for-goutil branch 4 times, most recently from 3468014 to ea5ec9e Compare September 19, 2022 06:01

fix: Windows platform test failure

8476fb6

- Avoid to check OS dependent error message (wrap them with custom message). - Avoid use of OS dependent directory separator.

KEINOS force-pushed the fix-add-tests-for-goutil branch from ea5ec9e to 8476fb6 Compare September 19, 2022 07:00

nao1215 merged commit 4f7d83e into nao1215:main Sep 19, 2022

KEINOS deleted the fix-add-tests-for-goutil branch September 19, 2022 07:12

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add unit test for goutil package #41

Add unit test for goutil package #41

KEINOS commented Sep 17, 2022 •

edited

Loading

codecov bot commented Sep 17, 2022 •

edited

Loading

nao1215 commented Sep 17, 2022

KEINOS commented Sep 18, 2022

nao1215 commented Sep 18, 2022 •

edited

Loading

KEINOS commented Sep 19, 2022

nao1215 commented Sep 19, 2022

KEINOS commented Sep 19, 2022

KEINOS commented Sep 19, 2022

nao1215 commented Sep 19, 2022

KEINOS commented Sep 19, 2022

KEINOS commented Sep 19, 2022 •

edited

Loading

nao1215 commented Sep 19, 2022

Add unit test for goutil package #41

Add unit test for goutil package #41

Conversation

KEINOS commented Sep 17, 2022 • edited Loading

codecov bot commented Sep 17, 2022 • edited Loading

Codecov Report

nao1215 commented Sep 17, 2022

KEINOS commented Sep 18, 2022

nao1215 commented Sep 18, 2022 • edited Loading

KEINOS commented Sep 19, 2022

nao1215 commented Sep 19, 2022

KEINOS commented Sep 19, 2022

KEINOS commented Sep 19, 2022

nao1215 commented Sep 19, 2022

KEINOS commented Sep 19, 2022

KEINOS commented Sep 19, 2022 • edited Loading

macOS

Linux (Debian, Docker+golang:latest)

Windows

nao1215 commented Sep 19, 2022

KEINOS commented Sep 17, 2022 •

edited

Loading

codecov bot commented Sep 17, 2022 •

edited

Loading

nao1215 commented Sep 18, 2022 •

edited

Loading

KEINOS commented Sep 19, 2022 •

edited

Loading

Linux (Debian, Docker+`golang:latest`)