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.

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

Allow to add to existing assessment collection #37

Merged
merged 2 commits into from
Apr 17, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
34 changes: 19 additions & 15 deletions evaluate/metrics/assessment.go
Original file line number Diff line number Diff line change
Expand Up @@ -24,26 +24,30 @@ var (
AssessmentKeyNoExcessResponse = RegisterAssessmentKey("no-excess-response")
)

// Assessments holds numerical assessment metrics.
// Assessments holds a collection of numerical assessment metrics.
type Assessments map[AssessmentKey]uint

// Merge combines two assessments into a new assessment and returns it.
func (a Assessments) Merge(o Assessments) Assessments {
if a == nil {
a = Assessments{}
}
if o == nil {
o = Assessments{}
}
// NewAssessments create a new assessment collection.
func NewAssessments() Assessments {
return map[AssessmentKey]uint{}
}

assessments := map[AssessmentKey]uint{}
// Add adds the given assessment collection to the current one.
func (a Assessments) Add(x Assessments) {
for k, v := range x {
a[k] += v
}
}

for _, k := range allAssessmentKeys {
assessments[k] = a[k]
// Merge combines two assessment collections into a new assessment collection and returns the new assessment collection.
func Merge(a Assessments, b Assessments) (c Assessments) {
c = NewAssessments()
if a != nil {
c.Add(a)
}
for _, k := range allAssessmentKeys {
assessments[k] = o[k]
if b != nil {
c.Add(b)
}

return Assessments(assessments)
return c
}
116 changes: 116 additions & 0 deletions evaluate/metrics/assessment_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,116 @@
package metrics

import (
"testing"

"github.com/stretchr/testify/assert"
)

func TestAssessmentsAdd(t *testing.T) {
type testCase struct {
Name string

Assessments Assessments
X Assessments

ExpectedAssessments Assessments
}

validate := func(t *testing.T, tc *testCase) {
t.Run(tc.Name, func(t *testing.T) {
tc.Assessments.Add(tc.X)

assert.Equal(t, tc.Assessments, tc.ExpectedAssessments)
})
}

validate(t, &testCase{
Name: "Empty",

Assessments: NewAssessments(),
X: NewAssessments(),

ExpectedAssessments: NewAssessments(),
})

validate(t, &testCase{
Name: "Non existing key",

Assessments: NewAssessments(),
X: map[AssessmentKey]uint{
AssessmentKeyNoExcessResponse: 1,
},

ExpectedAssessments: map[AssessmentKey]uint{
AssessmentKeyNoExcessResponse: 1,
},
})

validate(t, &testCase{
Name: "Existing key",

Assessments: map[AssessmentKey]uint{
AssessmentKeyNoExcessResponse: 1,
},
X: map[AssessmentKey]uint{
AssessmentKeyNoExcessResponse: 1,
},

ExpectedAssessments: map[AssessmentKey]uint{
AssessmentKeyNoExcessResponse: 2,
},
})
}

func TestMerge(t *testing.T) {
type testCase struct {
Name string

A Assessments
B Assessments

ExpectedC Assessments
}

validate := func(t *testing.T, tc *testCase) {
t.Run(tc.Name, func(t *testing.T) {
actualC := Merge(tc.A, tc.B)

assert.Equal(t, tc.ExpectedC, actualC)
})
}

validate(t, &testCase{
Name: "Empty",

ExpectedC: NewAssessments(),
})

validate(t, &testCase{
Name: "Non existing key",

A: NewAssessments(),
B: map[AssessmentKey]uint{
AssessmentKeyNoExcessResponse: 1,
},

ExpectedC: map[AssessmentKey]uint{
AssessmentKeyNoExcessResponse: 1,
},
})

validate(t, &testCase{
Name: "Existing key",

A: map[AssessmentKey]uint{
AssessmentKeyNoExcessResponse: 1,
},
B: map[AssessmentKey]uint{
AssessmentKeyNoExcessResponse: 1,
},

ExpectedC: map[AssessmentKey]uint{
AssessmentKeyNoExcessResponse: 2,
},
})
}
2 changes: 1 addition & 1 deletion evaluate/metrics/metrics.go
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ func (m Metrics) Add(o Metrics) Metrics {

Coverage: append(m.Coverage, o.Coverage...),

Assessments: m.Assessments.Merge(o.Assessments),
Assessments: Merge(m.Assessments, o.Assessments),
}
}

Expand Down
2 changes: 1 addition & 1 deletion evaluate/repository.go
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ func EvaluateRepository(model model.Model, language language.Language, repositor

continue
}
metrics.Assessments = metrics.Assessments.Merge(assessments)
metrics.Assessments.Add(assessments)

coverage, err := language.Execute(temporaryRepositoryPath)
if err != nil {
Expand Down
Loading