github-vet / github-vet/rangeloop-pointer-findings

MarcGrol/microgen: lib/test/scenario.go; 3 LoC

Open
#17,454 0 comments 0 reactions 0 assignees View on GitHub
fresh tiny
Dominant language
No language data
Stars
0
Forks
0
PR merge metrics
PR metrics pending

Description

Found a possible issue in [MarcGrol/microgen](https://www.github.com/MarcGrol/microgen) at [lib/test/scenario.go](https://github.com/MarcGrol/microgen/blob/dc82d6eff8272b77468eb9dbc7ce43698fdfff41/lib/test/scenario.go#L42-L44)

Below is the message reported by the analyzer for this snippet of code. Beware that the analyzer only reports the first issue it finds, so please do not limit your consideration to the contents of the below message.

> function call at line 43 passes reference to given to third-party code

[Click here to see the code in its original context.](https://github.com/MarcGrol/microgen/blob/dc82d6eff8272b77468eb9dbc7ce43698fdfff41/lib/test/scenario.go#L42-L44)

Click here to show the 3 line(s) of Go which triggered the analyzer.

```go
for _, given := range s.Given {
s.Store.Store(&given)
}

```

Click here to show extra information the analyzer produced.

```
No path was found through the callgraph that could lead to a function which writes a pointer argument.

The following graphviz dot graph describes paths through the callgraph that could lead to a function which passes a pointer to third-party code:
digraph G {
"(writeEvent, 1)" -> {}
"(Store, 1)" -> {"(writeEvent, 1)";}
}

```

Leave a reaction on this issue to contribute to the project by classifying this instance as a **Bug** :-1:, **Mitigated** :+1:, or **Desirable Behavior** :rocket:
See the descriptions of the classifications [here](https://github.com/github-vet/rangeclosure-findings#how-can-i-help) for more information.

commit ID: dc82d6eff8272b77468eb9dbc7ce43698fdfff41

Contributor guide

No contributing guide indexed for this repository

Research direction

Open lib/test/scenario.go at lines 42-44 and inspect the loop together with Store.Store and the reported writeEvent path. Compare the analyzer's finding with the surrounding code, then classify the instance by leaving the requested Bug, Mitigated, or Desirable Behavior reaction.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
devtools
Issue type
Bug
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.