Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Changed log.info to tidy up using fmt.sprintf #2246

Merged
merged 19 commits into from
Dec 9, 2019
Merged

Changed log.info to tidy up using fmt.sprintf #2246

Show file tree
Hide file tree
Changes from 14 commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
86981e0
Changed log.info to tidy up using fmt.sprintf
Nov 20, 2019
894f3cf
maxWorkers logic added for log.info
Nov 21, 2019
9b9bce9
removed commented code
Nov 21, 2019
3d06649
Changed log.info to tidy up using fmt.sprintf
Nov 20, 2019
2fed3b3
leader election bugfix: Delete evicted leader pods (#2210)
asmacdo Nov 20, 2019
d34bf29
feat(linter) : add goconst check and fix issues (#2236)
camilamacedo86 Nov 21, 2019
681e441
maxWorkers logic added for log.info
Nov 21, 2019
bd4d60a
logic added
Nov 21, 2019
d3870fd
2246 PR log addedin CHANGELOG file
Nov 21, 2019
c0d9b5a
Merge branch 'watches-go' of github.com:bharathi-tenneti/operator-sdk…
Nov 21, 2019
cc4ef7c
Rebased to master
Nov 22, 2019
e2fc799
Added getIntegerEnvWithDefault func
Dec 4, 2019
fa18fa6
Added CHANGELOG comment for PR2246
Dec 4, 2019
155020f
Restored Go.mod with upstream
Dec 4, 2019
24d80f5
Removed empty lines, ok==false changed
Dec 5, 2019
10fae31
Restored go.mod, and go.sum
Dec 5, 2019
59819b5
Fixed case for Log messages
Dec 6, 2019
f2c7fd3
Ran make format
Dec 6, 2019
d906611
maxWorkers<=0 check added
Dec 9, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
### Removed

### Bug Fixes
- Fixed log formatting issue that occurred while loading the configuration for Ansible-based operators. ([#2246](https://github.com/operator-framework/operator-sdk/pull/2246))
- Fix issue faced in the Ansible based operators when `jmespath` queries are used because it was not installed. ([#2252](https://github.com/operator-framework/operator-sdk/pull/2252))

## v0.12.0
Expand Down
35 changes: 19 additions & 16 deletions pkg/ansible/watches/watches.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -272,17 +272,7 @@ func getMaxWorkers(gvk schema.GroupVersionKind, defValue int) int {
"_",
-1,
))
maxWorkers, err := strconv.Atoi(os.Getenv(envVar))
if err != nil {
// we don't care why we couldn't parse it just use default
log.Info("Failed to parse %v from environment. Using default %v", envVar, defValue)
return defValue
}

if maxWorkers <= 0 {
log.Info("Value %v not valid. Using default %v", maxWorkers, defValue)
return defValue
}
maxWorkers := getIntegerEnvWithDefault(envVar, defValue)
return maxWorkers
}

Expand All @@ -295,11 +285,8 @@ func getAnsibleVerbosity(gvk schema.GroupVersionKind, defValue int) int {
"_",
-1,
))
ansibleVerbosity, err := strconv.Atoi(os.Getenv(envVar))
if err != nil {
log.Info("Failed to parse %v from environment. Using default %v", envVar, defValue)
return defValue
}

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: this extraneous empty line can be removed.

ansibleVerbosity := getIntegerEnvWithDefault(envVar, defValue)

// Use default value when value doesn't make sense
if ansibleVerbosity < 0 {
Expand All @@ -312,3 +299,19 @@ func getAnsibleVerbosity(gvk schema.GroupVersionKind, defValue int) int {
}
return ansibleVerbosity
}

// Returns value for MaxWorkers/Ansibleverbosity based on if envVar is set or a defvalue is used.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: Go doc convention is to use the identifier name (in this case the function name) as the first word of the comment. Not a huge deal since this function is unexported, but a good habit nonetheless.

func getIntegerEnvWithDefault(envVar string, defValue int) int {
val := defValue
if envVal, ok := os.LookupEnv(envVar); ok {
if i, err := strconv.Atoi(envVal); err != nil {
log.Info("could not parse environment variable as an integer; using default value", "envVar", envVar, "default", defValue)

} else {
val = i
}
} else if ok==false {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit:

Suggested change
} else if ok==false {
} else if !ok {

log.Info("environment variable not set; using default value", "envVar", envVar, "default", defValue)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like the sanity test is complaining that these log.Info messages don't start with an upper case letter.

So we need:
Could not parse environment variable... and Environment variable not set...

}
return val
}