ossf/scorecard
1
1
Fork 0
mirror of https://github.com/ossf/scorecard.git synced 2024-10-05 13:17:08 +03:00
Code Issues Actions 7 Packages Projects Releases Wiki Activity

🌱 Add script to set up probe boilerplate (#3948)

Browse Source 
* Add script

Signed-off-by: Raghav Kaul <raghavkaul+github@google.com>

* script -> go

Signed-off-by: Raghav Kaul <raghavkaul+github@google.com>

* v4 -> v5

Signed-off-by: Raghav Kaul <raghavkaul+github@google.com>

* update

Signed-off-by: Raghav Kaul <raghavkaul+github@google.com>

* update

Signed-off-by: Raghav Kaul <raghavkaul+github@google.com>

---------

Signed-off-by: Raghav Kaul <raghavkaul+github@google.com>
This commit is contained in:
Raghav Kaul 2024-05-08 13:58:02 -04:00 committed by GitHub
parent 6b5cb27cd0
commit 256d5a3b50
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 150 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
Makefile
View File

@ -174,6 +174,9 @@ validate-docs: docs/checks/internal/generate/main.go
# Validating checks.yaml
go run ./docs/checks/internal/validate/main.go
setup-probe:
go run ./probes/internal/scripts/setup.go $(probeName)
SCORECARD_DEPS = $(shell find . -iname "*.go" | grep -v tools/)
build-scorecard: ## Build Scorecard CLI
build-scorecard: scorecard

147
probes/internal/scripts/setup.go Normal file
View File

@ -0,0 +1,147 @@
// Copyright 2024 OpenSSF Scorecard Authors
//
// 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 main
import (
"fmt"
"os"
"path"
"time"
)
func main() {
if len(os.Args) != 2 {
panic("usage: make setup-probe probeName=arg")
}
pn := os.Args[1]
pd := path.Join("probes", pn)
err := os.Mkdir(pd, 0o700)
if err != nil {
panic(err)
}
y := time.Now().Year()
implBoilerplate := fmt.Sprintf(`// Copyright %d OpenSSF Scorecard Authors
//
// 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.
//nolint:stylecheck
package %s
import (
"embed"
"github.com/ossf/scorecard/v5/checker"
"github.com/ossf/scorecard/v5/finding"
)
//go:embed *.yml
var fs embed.FS
const (
Probe = "%s"
)
// If your probe is associated with a Scorecard check, map it like so:
// and create the entry in probes/entries.go
// func init() {
// probes.MustRegister(Probe, Run, []probes.CheckName{probes.<ProbeName>})
// }
// If your probe isn't supposed to be part of a Scorecard check, you must
// register it independently:
// func init() {
// probes.MustRegisterIndependent(Probe, Run)
// }
func Run(raw *checker.RawResults) ([]finding.Finding, string, error) {
return nil, "", nil
}
`, y, pn, pn)
err = os.WriteFile(path.Join(pd, "impl.go"), []byte(implBoilerplate), 0o600)
if err != nil {
panic(err)
}
implTestBoilerplate := fmt.Sprintf(`// Copyright %d OpenSSF Scorecard Authors
//
// 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.
//nolint:stylecheck
package %s
`, y, pn)
err = os.WriteFile(path.Join(pd, "impl_test.go"), []byte(implTestBoilerplate), 0o600)
if err != nil {
panic(err)
}
defYmlBoilerplate := fmt.Sprintf(`# Copyright %d OpenSSF Scorecard Authors
#
# 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.
id: %s
short: A short description of this probe
motivation: >
What is the motivation for this probe?
implementation: >
How does this probe work under-the-hood?
outcome:
-
remediation:
onOutcome: # Which direction of a probe outcome (True/False) requires a "fix"?
effort: # High, Medium, Low
text:
-
ecosystem:
languages:
-
clients:
-
`, y, pn)
err = os.WriteFile(path.Join(pd, "def.yml"), []byte(defYmlBoilerplate), 0o600)
if err != nil {
panic(err)
}
}