Rename reporter to result2oscal

Signed-off-by: Takumi Yanagawa <[email protected]>
oscal-compass · Dec 7, 2023 · 4ca1c16 · 4ca1c16
1 parent 6ca8ef3
commit 4ca1c16
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 15 deletions.
diff --git a/cmd/ocm/result2oscal/cmd/cmd.go b/cmd/ocm/result2oscal/cmd/cmd.go
@@ -24,7 +24,7 @@ import (
 	"github.com/IBM/compliance-to-policy/cmd/ocm/result2oscal/options"
 	"github.com/IBM/compliance-to-policy/pkg"
 	"github.com/IBM/compliance-to-policy/pkg/c2pcr"
-	"github.com/IBM/compliance-to-policy/pkg/ocm/reporter"
+	"github.com/IBM/compliance-to-policy/pkg/ocm"
 	typec2pcr "github.com/IBM/compliance-to-policy/pkg/types/c2pcr"
 )
 
@@ -69,7 +69,7 @@ func Run(options *options.Options) error {
 		panic(err)
 	}
 
-	r := reporter.NewReporter(c2pcrParsed)
+	r := ocm.NewResultToOscal(c2pcrParsed)
 	arRoot, err := r.Generate()
 	if err != nil {
 		panic(err)

diff --git a/pkg/ocm/reporter/helper.go → pkg/ocm/helper.go b/pkg/ocm/reporter/helper.go → pkg/ocm/helper.go
@@ -14,7 +14,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
-package reporter
+package ocm
 
 import (
 	typeconfigpolicy "github.com/IBM/compliance-to-policy/pkg/types/configurationpolicy"

diff --git a/pkg/ocm/reporter/reporter.go → pkg/ocm/result2oscal.go b/pkg/ocm/reporter/reporter.go → pkg/ocm/result2oscal.go
@@ -14,7 +14,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
-package reporter
+package ocm
 
 import (
 	"fmt"
@@ -24,7 +24,6 @@ import (
 	"time"
 
 	"github.com/IBM/compliance-to-policy/pkg"
-	"go.uber.org/zap"
 	sigyaml "sigs.k8s.io/yaml"
 
 	"k8s.io/apimachinery/pkg/util/sets"
@@ -39,9 +38,7 @@ import (
 	typeutils "github.com/IBM/compliance-to-policy/pkg/types/utils"
 )
 
-var logger *zap.Logger = pkg.GetLogger("reporter")
-
-type Reporter struct {
+type ResultToOscal struct {
 	c2pParsed          typec2pcr.C2PCRParsed
 	policies           []*typepolicy.Policy
 	policySets         []*typepolicy.PolicySet
@@ -61,8 +58,8 @@ const (
 	GenerationTypePolicyReport GenerationType = "policy-report"
 )
 
-func NewReporter(c2pParsed typec2pcr.C2PCRParsed) *Reporter {
-	r := Reporter{
+func NewResultToOscal(c2pParsed typec2pcr.C2PCRParsed) *ResultToOscal {
+	r := ResultToOscal{
 		c2pParsed:          c2pParsed,
 		policies:           []*typepolicy.Policy{},
 		policySets:         []*typepolicy.PolicySet{},
@@ -71,7 +68,7 @@ func NewReporter(c2pParsed typec2pcr.C2PCRParsed) *Reporter {
 	return &r
 }
 
-func (r *Reporter) Generate() (*typear.AssessmentResultsRoot, error) {
+func (r *ResultToOscal) Generate() (*typear.AssessmentResultsRoot, error) {
 	traverseFunc := genTraverseFunc(
 		func(policy typepolicy.Policy) { r.policies = append(r.policies, &policy) },
 		func(policySet typepolicy.PolicySet) { r.policySets = append(r.policySets, &policySet) },
@@ -243,7 +240,7 @@ func (r *Reporter) Generate() (*typear.AssessmentResultsRoot, error) {
 	return &arRoot, nil
 }
 
-func (r *Reporter) GenerateReasonsFromRawPolicies(policy typepolicy.Policy) []Reason {
+func (r *ResultToOscal) GenerateReasonsFromRawPolicies(policy typepolicy.Policy) []Reason {
 	reasons := []Reason{}
 	for _, status := range policy.Status.Status {
 		clusterName := status.ClusterName

diff --git a/pkg/ocm/reporter/reporter_test.go → pkg/ocm/result2oscal_test.go b/pkg/ocm/reporter/reporter_test.go → pkg/ocm/result2oscal_test.go
@@ -14,7 +14,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
-package reporter
+package ocm
 
 import (
 	"os"
@@ -29,7 +29,7 @@ import (
 	"github.com/stretchr/testify/assert"
 )
 
-func TestReporter(t *testing.T) {
+func TestResult2Oscal(t *testing.T) {
 
 	policyDir := pkg.PathFromPkgDirectory("./testdata/ocm/policies")
 	policyResultsDir := pkg.PathFromPkgDirectory("./testdata/ocm/policy-results")
@@ -79,7 +79,7 @@ func TestReporter(t *testing.T) {
 	c2pcrParsed, err := c2pcrParser.Parse(c2pcrSpec)
 	assert.NoError(t, err, "Should not happen")
 
-	reporter := NewReporter(c2pcrParsed)
+	reporter := NewResultToOscal(c2pcrParsed)
 	arRoot, err := reporter.Generate()
 	assert.NoError(t, err, "Should not happen")