Merge pull request #8 from owenrumney/add-get-rule-by-id

Add GetRuleById

models/run.go

@@ -1,5 +1,9 @@
 package models
 
+import (
+	"fmt"
+)
+
 // Run type represents a run of a tool
 type Run struct {
 	Tool      *tool              `json:"tool"`
@@ -81,3 +85,15 @@ func updateResultLocationIndex(result *Result, location string, index int) {
 		}
 	}
 }
+
+func (run *Run) GetRuleById(ruleId string) (*Rule, error) {
+	if run.Tool != nil || run.Tool.Driver != nil {
+		for _, rule := range run.Tool.Driver.Rules {
+			if rule.ID == ruleId {
+				return rule, nil
+			}
+		}
+	}
+
+	return nil, fmt.Errorf("couldn't find rule %s", ruleId)
+}

test/run_stage_test.go

@@ -86,3 +86,11 @@ func (rt *runTest) aResultIsAddedToTheRunWithHelpText() *runTest {
 	rt.run.AddResultDetails(rule, result, resultLocation)
 	return rt
 }
+
+func (rt *runTest) gettingRuleByIdReturnsRule() {
+	rule, err := rt.run.GetRuleById("AWS001")
+
+	assert.NoError(rt.t, err)
+	assert.Equal(rt.t, "AWS001", rule.ID)
+	assert.Equal(rt.t, "S3 Bucket has an ACL defined which allows public access.", rule.ShortDescription.Text)
+}

test/run_test.go

@@ -60,3 +60,11 @@ func Test_create_a_run_with_a_result_added_and_help_text_provided(t *testing.T)
 		theRunIsConvertedToAString()
 	then.theJSONStringRepresentationOfTheRunShouldBe(expected)
 }
+
+func Test_create_a_run_with_a_rule_and_get_the_rule_by_id(t *testing.T) {
+	given, when, then := createNewRunTest(t)
+
+	given.aNewRunIsCreated()
+	when.aResultIsAddedToTheRunWithHelpText()
+	then.gettingRuleByIdReturnsRule()
+}