/
default_engine_formatter.go
77 lines (65 loc) · 2.57 KB
/
default_engine_formatter.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
// Copyright 2020 ZUP IT SERVICOS EM TECNOLOGIA E INOVACAO SA
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package formatters
import (
"path/filepath"
"github.com/ZupIT/horusec-devkit/pkg/enums/languages"
"github.com/ZupIT/horusec-devkit/pkg/enums/tools"
"github.com/ZupIT/horusec-devkit/pkg/utils/logger"
engine "github.com/ZupIT/horusec-engine"
"github.com/ZupIT/horusec/internal/enums/engines"
"github.com/ZupIT/horusec/internal/helpers/messages"
)
type RuleManager interface {
GetAllRules() []engine.Rule
GetTextUnitByRulesExt(src string) ([]engine.Unit, error)
}
// DefaultFormatter is a formatter that can be used with horusec engines implementation
type DefaultFormatter struct {
svc IService
manager RuleManager
language languages.Language
}
func NewDefaultFormatter(svc IService, manager RuleManager, language languages.Language) IFormatter {
return &DefaultFormatter{
svc: svc,
manager: manager,
language: language,
}
}
func (f *DefaultFormatter) StartAnalysis(src string) {
if f.svc.ToolIsToIgnore(tools.HorusecEngine) {
logger.LogDebugWithLevel(messages.MsgDebugToolIgnored + tools.HorusecEngine.ToString())
return
}
f.svc.SetAnalysisError(f.execEngineAndParseResults(src), tools.HorusecEngine, "", src)
f.svc.LogDebugWithReplace(messages.MsgDebugToolFinishAnalysis, tools.HorusecEngine, f.language)
}
func (f *DefaultFormatter) execEngineAndParseResults(src string) error {
f.svc.LogDebugWithReplace(messages.MsgDebugToolStartAnalysis, tools.HorusecEngine, f.language)
findings, err := f.execEngineAnalysis(src)
if err != nil {
return err
}
f.svc.ParseFindingsToVulnerabilities(findings, tools.HorusecEngine, f.language)
return nil
}
func (f *DefaultFormatter) execEngineAnalysis(src string) ([]engine.Finding, error) {
textUnit, err := f.manager.GetTextUnitByRulesExt(filepath.Join(f.svc.GetConfigProjectPath(), src))
if err != nil {
return nil, err
}
allRules := append(f.manager.GetAllRules(), f.svc.GetCustomRulesByLanguage(f.language)...)
return engine.RunMaxUnitsByAnalysis(textUnit, allRules, engines.DefaultMaxUnitsPerAnalysis), nil
}