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

yarnaudit:chore - improve tests and code cleaning #910

Merged
merged 1 commit into from
Jan 3, 2022
Merged

yarnaudit:chore - improve tests and code cleaning #910

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion internal/services/formatters/javascript/npmaudit/formatter_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ func TestNpmAuditParseOutput(t *testing.T) {
assert.False(t, analysis.HasErrors(), "Expected no errors on analysis")
})

t.Run("Should add error on analysos when parse output with not found error", func(t *testing.T) {
t.Run("Should add error on analysis when parse output with not found error", func(t *testing.T) {
analysis := new(analysis.Analysis)

dockerAPIControllerMock := testutil.NewDockerMock()
Expand Down
4 changes: 2 additions & 2 deletions .../javascript/yarnaudit/entities/finding.go → ...ormatters/javascript/yarnaudit/finding.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@
// See the License for the specific language governing permissions and
// limitations under the License.

package entities
package yarnaudit

type Finding struct {
type finding struct {
Version string `json:"version"`
}
68 changes: 31 additions & 37 deletions internal/services/formatters/javascript/yarnaudit/formatter.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,11 +29,10 @@ import (
"github.com/ZupIT/horusec-devkit/pkg/enums/tools"
"github.com/ZupIT/horusec-devkit/pkg/utils/logger"

dockerEntities "github.com/ZupIT/horusec/internal/entities/docker"
"github.com/ZupIT/horusec/internal/entities/docker"
"github.com/ZupIT/horusec/internal/enums/images"
"github.com/ZupIT/horusec/internal/helpers/messages"
"github.com/ZupIT/horusec/internal/services/formatters"
"github.com/ZupIT/horusec/internal/services/formatters/javascript/yarnaudit/entities"
vulnhash "github.com/ZupIT/horusec/internal/utils/vuln_hash"
)

Expand All @@ -45,7 +44,7 @@ type Formatter struct {
func NewFormatter(service formatters.IService) formatters.IFormatter {
return &Formatter{
IService: service,
modules: map[string]bool{},
modules: make(map[string]bool),
}
}

Expand All @@ -71,8 +70,8 @@ func (f *Formatter) startYarnAudit(projectSubPath string) (string, error) {
return output, f.parseOutput(output, projectSubPath)
}

func (f *Formatter) getDockerConfig(projectSubPath string) *dockerEntities.AnalysisData {
analysisData := &dockerEntities.AnalysisData{
func (f *Formatter) getDockerConfig(projectSubPath string) *docker.AnalysisData {
analysisData := &docker.AnalysisData{
CMD: f.GetConfigCMDByFileExtension(projectSubPath, CMD, "yarn.lock", tools.YarnAudit),
Language: languages.Javascript,
}
Expand All @@ -95,74 +94,69 @@ func (f *Formatter) parseOutput(containerOutput, projectSubPath string) error {
}

func (f *Formatter) VerifyErrors(containerOutput string) error {
if f.IsNotFoundError(containerOutput) {
if f.isNotFoundError(containerOutput) {
return errors.New(messages.MsgErrorYarnLockNotFound)
}

if f.IsRunningError(containerOutput) {
if f.isRunningError(containerOutput) {
return errors.New(messages.MsgErrorYarnProcess + containerOutput)
}

return nil
}

func (f *Formatter) IsNotFoundError(containerOutput string) bool {
func (f *Formatter) isNotFoundError(containerOutput string) bool {
return strings.Contains(containerOutput, "ERROR_YARN_LOCK_NOT_FOUND")
}

func (f *Formatter) IsRunningError(containerOutput string) bool {
func (f *Formatter) isRunningError(containerOutput string) bool {
return strings.Contains(containerOutput, "ERROR_RUNNING_YARN_AUDIT")
}

func (f *Formatter) newContainerOutputFromString(containerOutput string) (output *entities.Output, err error) {
func (f *Formatter) newContainerOutputFromString(containerOutput string) (output *yarnOutput, err error) {
if containerOutput == "" {
logger.LogDebugWithLevel(messages.MsgDebugOutputEmpty,
map[string]interface{}{"tool": tools.YarnAudit.ToString()})
return &entities.Output{}, nil
map[string]interface{}{"tool": tools.YarnAudit.ToString()},
)
return &yarnOutput{}, nil
}

return output, json.Unmarshal([]byte(containerOutput), &output)
}

func (f *Formatter) processOutput(output *entities.Output, projectSubPath string) {
func (f *Formatter) processOutput(output *yarnOutput, projectSubPath string) {
for _, advisory := range output.Advisories {
if f.notContainsModule(advisory.ModuleName) {
advisoryPointer := advisory
f.AddNewVulnerabilityIntoAnalysis(f.setVulnerabilitySeverityData(&advisoryPointer, projectSubPath))
f.AddNewVulnerabilityIntoAnalysis(f.newVulnerability(&advisoryPointer, projectSubPath))
}
}
}

func (f *Formatter) setVulnerabilitySeverityData(
output *entities.Issue, projectSubPath string) *vulnerability.Vulnerability {
data := f.getDefaultVulnerabilitySeverity(projectSubPath)
data.Severity = output.GetSeverity()
data.Details = output.Overview
data.Code = output.ModuleName
data.Line = f.getVulnerabilityLineByName(data.Code, output.GetVersion(), data.File)
data = vulnhash.Bind(data)
return f.SetCommitAuthor(data)
}

func (f *Formatter) getDefaultVulnerabilitySeverity(projectSubPath string) *vulnerability.Vulnerability {
vulnerabilitySeverity := &vulnerability.Vulnerability{}
vulnerabilitySeverity.SecurityTool = tools.YarnAudit
vulnerabilitySeverity.Language = languages.Javascript
vulnerabilitySeverity.File = f.GetFilepathFromFilename("yarn.lock", projectSubPath)
return vulnerabilitySeverity
func (f *Formatter) newVulnerability(output *issue, projectSubPath string) *vulnerability.Vulnerability {
vuln := &vulnerability.Vulnerability{
SecurityTool: tools.YarnAudit,
Language: languages.Javascript,
File: f.GetFilepathFromFilename("yarn.lock", projectSubPath),
Severity: output.getSeverity(),
Details: output.Overview,
Code: output.ModuleName,
}
vuln.Line = f.getVulnerabilityLineByName(vuln.Code, output.getVersion(), vuln.File)
return f.SetCommitAuthor(vulnhash.Bind(vuln))
}

func (f *Formatter) getVulnerabilityLineByName(module, version, file string) string {
fileExisting, err := os.Open(filepath.Join(f.GetConfigProjectPath(), file))
func (f *Formatter) getVulnerabilityLineByName(module, version, filename string) string {
file, err := os.Open(filepath.Join(f.GetConfigProjectPath(), filename))
if err != nil {
return ""
}

defer func() {
logger.LogErrorWithLevel(messages.MsgErrorDeferFileClose, fileExisting.Close())
logger.LogErrorWithLevel(messages.MsgErrorDeferFileClose, file.Close())
}()

return f.getLine(module, version, bufio.NewScanner(fileExisting))
return f.getLine(module, version, bufio.NewScanner(file))
}

func (f *Formatter) getLine(module, version string, scanner *bufio.Scanner) string {
Expand All @@ -180,7 +174,7 @@ func (f *Formatter) getLine(module, version string, scanner *bufio.Scanner) stri
}

func (f *Formatter) validateIfExistNameInScannerText(scannerText, module, version string) bool {
for _, name := range f.mapPossibleExistingNames(module, version) {
for _, name := range f.possibleExistingNames(module, version) {
if strings.Contains(strings.ToLower(scannerText), name) {
return true
}
Expand All @@ -189,7 +183,7 @@ func (f *Formatter) validateIfExistNameInScannerText(scannerText, module, versio
return false
}

func (f *Formatter) mapPossibleExistingNames(module, version string) []string {
func (f *Formatter) possibleExistingNames(module, version string) []string {
return []string{
strings.ToLower(fmt.Sprintf("%s@%s", module, version)),
strings.ToLower(fmt.Sprintf("%s@~%s", module, version)),
Expand Down
Loading