Fix coding guideline about constructor due to mock implementation #792

hlts2 · 2020-10-21T06:20:23Z

Description:

WHY

when I fixed the implementation so that object can be created via interface for mocking, I forgot to fix the constructor.
So nil pointer exception bug occurs.

WHAT

Write a coding guideline about constructor for mocking
- Constructor method returns an error
- Field validation in the constructor method (after setting the options)
- Set the internally generated object with the private unexported option.

Related Card:

https://github.com/vdaas/vald/projects/3#card-47624462

Related Issue:

How Has This Been Tested?:

Environment:

Go Version: 1.15.2
Docker Version: 19.03.8
Kubernetes Version: 1.18.2
NGT Version: 1.12.1

Types of changes:

Bug fix [type/bug]
New feature [type/feature]
Add tests [type/test]
Security related changes [type/security]
Add documents [type/documentation]
Refactoring [type/refactoring]
Update dependencies [type/dependency]
Update benchmarks and performances [type/bench]
Update CI [type/ci]

Changes to Core Features:

Have you added an explanation of what your changes do and why you'd like us to include them?
Have you written new tests for your core changes, as applicable?
Have you successfully ran tests with your changes locally?

Checklist:

I have read the CONTRIBUTING document.
I have checked open Pull Requests for the similar feature or fixes?
I have added tests and benchmarks to cover my changes.
I have ensured all new and existing tests passed.
I have commented my code, particularly in hard-to-understand areas
I have updated the documentation accordingly.

Signed-off-by: hlts2 <hiroto.funakoshi.hiroto@gmail.com>

vdaas-ci · 2020-10-21T06:20:38Z

[CHATOPS:HELP] ChatOps commands.

🙆‍♀️ /approve - approve
💌 /changelog - add changelog comment
🍱 /format - format codes and add licenses
✅ /gen-test - generate test codes
🏷️ /label - add labels
⏪ /rebase - rebase master

github-actions

Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit

LanguageTool

docs/contributing/coding-style.md

hlts2 · 2020-10-26T01:13:51Z

/rebase

vdaas-ci · 2020-10-26T01:14:27Z

[REBASE] Rebase triggered by hlts2 for branch: documentation/fix-coding-guidelines-about-constructor

docs/contributing/coding-style.md

Co-authored-by: Kevin Diu <kevindiujp@gmail.com>

github-actions

Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit

LanguageTool

docs/contributing/coding-style.md

Co-authored-by: Kevin Diu <kevindiujp@gmail.com>

docs/contributing/coding-style.md

Signed-off-by: hlts2 <hiroto.funakoshi.hiroto@gmail.com>

docs/contributing/coding-style.md

Co-authored-by: Kevin Diu <kevindiujp@gmail.com>

kevindiu

LGTM

vankichi · 2020-10-26T05:11:32Z

please fill out description without URL and this PR title does not match your changes.

vankichi · 2020-10-26T07:24:36Z

/rebase
/format
/approve

vdaas-ci · 2020-10-26T07:25:12Z

[REBASE] Rebase triggered by vankichi for branch: documentation/fix-coding-guidelines-about-constructor

vdaas-ci · 2020-10-26T07:26:05Z

[FORMAT] Updating license headers and formatting go codes triggered by vankichi.

Signed-off-by: vdaas-ci <ci@vdaas.org>

vdaas-ci

[APPROVED] This PR is approved by vankichi.

codecov · 2020-10-26T07:41:49Z

Codecov Report

Merging #792 into master will decrease coverage by 0.13%.
The diff coverage is 23.07%.

@@            Coverage Diff             @@
##           master     #792      +/-   ##
==========================================
- Coverage   16.92%   16.79%   -0.14%     
==========================================
  Files         421      421              
  Lines       19528    19534       +6     
==========================================
- Hits         3305     3280      -25     
- Misses      15999    16023      +24     
- Partials      224      231       +7

Impacted Files	Coverage Δ
internal/db/storage/blob/s3/s3.go	`0.00% <0.00%> (ø)`
pkg/gateway/vald/handler/grpc/handler.go	`0.00% <0.00%> (ø)`
internal/db/storage/blob/s3/reader/reader.go	`65.90% <33.33%> (-34.10%)`	⬇️
internal/db/storage/blob/s3/reader/option.go	`100.00% <100.00%> (ø)`
internal/worker/worker.go	`83.33% <0.00%> (+1.04%)`	⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 067e12e...fb9e5fe. Read the comment docs.

hlts2 added 2 commits October 19, 2020 18:16

feat: add document for constructor

2196cf9

Signed-off-by: hlts2 <hiroto.funakoshi.hiroto@gmail.com>

fix: typo

a77f00e

Signed-off-by: hlts2 <hiroto.funakoshi.hiroto@gmail.com>

hlts2 self-assigned this Oct 21, 2020

github-actions bot added size/M type/documentation priority/low labels Oct 21, 2020

github-actions bot reviewed Oct 21, 2020

View reviewed changes

hlts2 changed the title ~~[WIP] Fix coding guidelines about mock~~ Fix coding guidelines about mock Oct 26, 2020

hlts2 marked this pull request as ready for review October 26, 2020 01:16

kevindiu reviewed Oct 26, 2020

View reviewed changes

docs/contributing/coding-style.md Outdated Show resolved Hide resolved

docs/contributing/coding-style.md Outdated Show resolved Hide resolved

docs/contributing/coding-style.md Outdated Show resolved Hide resolved

kevindiu reviewed Oct 26, 2020

View reviewed changes

docs/contributing/coding-style.md Outdated Show resolved Hide resolved

hlts2 and others added 2 commits October 26, 2020 11:25

Update docs/contributing/coding-style.md

33f0dcd

Co-authored-by: Kevin Diu <kevindiujp@gmail.com>

Update docs/contributing/coding-style.md

f74e832

Co-authored-by: Kevin Diu <kevindiujp@gmail.com>

github-actions bot reviewed Oct 26, 2020

View reviewed changes

hlts2 and others added 2 commits October 26, 2020 11:32

Update docs/contributing/coding-style.md

4ee474f

Co-authored-by: Kevin Diu <kevindiujp@gmail.com>

Update docs/contributing/coding-style.md

e8fe62f

Co-authored-by: Kevin Diu <kevindiujp@gmail.com>

kevindiu reviewed Oct 26, 2020

View reviewed changes

docs/contributing/coding-style.md Show resolved Hide resolved

kevindiu reviewed Oct 26, 2020

View reviewed changes

docs/contributing/coding-style.md Outdated Show resolved Hide resolved

fix: indent

f252d0d

Signed-off-by: hlts2 <hiroto.funakoshi.hiroto@gmail.com>

github-actions bot reviewed Oct 26, 2020

View reviewed changes

kevindiu reviewed Oct 26, 2020

View reviewed changes

docs/contributing/coding-style.md Outdated Show resolved Hide resolved

Update docs/contributing/coding-style.md

2a0c6cd

Co-authored-by: Kevin Diu <kevindiujp@gmail.com>

kevindiu previously approved these changes Oct 26, 2020

View reviewed changes

hlts2 changed the title ~~Fix coding guidelines about mock~~ Fix coding guideline about constructor due to mock implementation Oct 26, 2020

🤖 Update license headers / Format go codes and yaml files

fb9e5fe

Signed-off-by: vdaas-ci <ci@vdaas.org>

vdaas-ci dismissed kevindiu’s stale review via fb9e5fe October 26, 2020 07:26

github-actions bot added the area/internal label Oct 26, 2020

vdaas-ci approved these changes Oct 26, 2020

View reviewed changes

vankichi merged commit 2ad623d into master Oct 27, 2020

vankichi deleted the documentation/fix-coding-guidelines-about-constructor branch October 27, 2020 07:48

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix coding guideline about constructor due to mock implementation #792

Fix coding guideline about constructor due to mock implementation #792

hlts2 commented Oct 21, 2020 •

edited

Loading

vdaas-ci commented Oct 21, 2020

github-actions bot left a comment

hlts2 commented Oct 26, 2020

vdaas-ci commented Oct 26, 2020

github-actions bot left a comment

kevindiu left a comment

vankichi commented Oct 26, 2020

vankichi commented Oct 26, 2020

vdaas-ci commented Oct 26, 2020

vdaas-ci commented Oct 26, 2020

vdaas-ci left a comment

codecov bot commented Oct 26, 2020 •

edited

Loading

Fix coding guideline about constructor due to mock implementation #792

Fix coding guideline about constructor due to mock implementation #792

Conversation

hlts2 commented Oct 21, 2020 • edited Loading

Description:

Related Card:

Related Issue:

How Has This Been Tested?:

Environment:

Types of changes:

Changes to Core Features:

Checklist:

vdaas-ci commented Oct 21, 2020

github-actions bot left a comment

Choose a reason for hiding this comment

hlts2 commented Oct 26, 2020

vdaas-ci commented Oct 26, 2020

github-actions bot left a comment

Choose a reason for hiding this comment

kevindiu left a comment

Choose a reason for hiding this comment

vankichi commented Oct 26, 2020

vankichi commented Oct 26, 2020

vdaas-ci commented Oct 26, 2020

vdaas-ci commented Oct 26, 2020

vdaas-ci left a comment

Choose a reason for hiding this comment

codecov bot commented Oct 26, 2020 • edited Loading

Codecov Report

hlts2 commented Oct 21, 2020 •

edited

Loading

codecov bot commented Oct 26, 2020 •

edited

Loading