forked from theupdateframework/go-tuf
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: update code comments, license year and init testing (theupdate…
…framework#3) * docs: add comments describing the different types Signed-off-by: Radoslav Dimitrov <[email protected]> * chore: add golangci and codeql Signed-off-by: Radoslav Dimitrov <[email protected]> * chore: begin adding tests Signed-off-by: Radoslav Dimitrov <[email protected]> * chore: add licence notice Signed-off-by: Radoslav Dimitrov <[email protected]> * chore: update licence year to 2023 Signed-off-by: Radoslav Dimitrov <[email protected]> * chore: fix linting error Signed-off-by: Radoslav Dimitrov <[email protected]> * chore: temp limit ci to ubuntu so we don't waste GHA resources Signed-off-by: Radoslav Dimitrov <[email protected]> Signed-off-by: Radoslav Dimitrov <[email protected]>
- Loading branch information
Showing
20 changed files
with
280 additions
and
14 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| # Copyright 2022-2023 VMware, Inc. | ||
| # | ||
| # This product is licensed to you under the BSD-2 license (the "License"). | ||
| # You may not use this product except in compliance with the BSD-2 License. | ||
| # This product may include a number of subcomponents with separate copyright | ||
| # notices and license terms. Your use of these subcomponents is subject to | ||
| # the terms and conditions of the subcomponent's license, as noted in the | ||
| # LICENSE file. | ||
| # | ||
| # SPDX-License-Identifier: BSD-2-Clause | ||
| on: | ||
| pull_request: | ||
| push: | ||
| branches: | ||
| - "master" | ||
| tags: | ||
| - "v*" | ||
| name: CI | ||
| jobs: | ||
| tests: | ||
| uses: ./.github/workflows/tests.yml |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,70 @@ | ||
| # For most projects, this workflow file will not need changing; you simply need | ||
| # to commit it to your repository. | ||
| # | ||
| # You may wish to alter this file to override the set of languages analyzed, | ||
| # or to provide custom queries or build logic. | ||
| # | ||
| # ******** NOTE ******** | ||
| # We have attempted to detect the languages in your repository. Please check | ||
| # the `language` matrix defined below to confirm you have the correct set of | ||
| # supported CodeQL languages. | ||
| # | ||
| name: "CodeQL" | ||
|
|
||
| on: | ||
| push: | ||
| branches: [ master ] | ||
| pull_request: | ||
| # The branches below must be a subset of the branches above | ||
| branches: [ master ] | ||
| schedule: | ||
| - cron: '25 14 * * 6' | ||
|
|
||
| jobs: | ||
| analyze: | ||
| name: Analyze | ||
| runs-on: ubuntu-latest | ||
| permissions: | ||
| actions: read | ||
| contents: read | ||
| security-events: write | ||
|
|
||
| strategy: | ||
| fail-fast: false | ||
| matrix: | ||
| language: [ 'go' ] | ||
| # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ] | ||
| # Learn more about CodeQL language support at https://git.io/codeql-language-support | ||
|
|
||
| steps: | ||
| - name: Checkout repository | ||
| uses: actions/checkout@v3 | ||
|
|
||
| # Initializes the CodeQL tools for scanning. | ||
| - name: Initialize CodeQL | ||
| uses: github/codeql-action/init@v2 | ||
| with: | ||
| languages: ${{ matrix.language }} | ||
| # If you wish to specify custom queries, you can do so here or in a config file. | ||
| # By default, queries listed here will override any specified in a config file. | ||
| # Prefix the list here with "+" to use these queries and those in the config file. | ||
| # queries: ./path/to/local/query, your-org/your-repo/queries@main | ||
|
|
||
| # Autobuild attempts to build any compiled languages (C/C++, C#, or Java). | ||
| # If this step fails, then you should remove it and run the build manually (see below) | ||
| - name: Autobuild | ||
| uses: github/codeql-action/autobuild@v2 | ||
|
|
||
| # ℹ️ Command-line programs to run using the OS shell. | ||
| # 📚 https://git.io/JvXDl | ||
|
|
||
| # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines | ||
| # and modify them (or add more) to build your code if your project | ||
| # uses a compiled language | ||
|
|
||
| #- run: | | ||
| # make bootstrap | ||
| # make release | ||
|
|
||
| - name: Perform CodeQL Analysis | ||
| uses: github/codeql-action/analyze@v2 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,68 @@ | ||
| # Copyright 2022-2023 VMware, Inc. | ||
| # | ||
| # This product is licensed to you under the BSD-2 license (the "License"). | ||
| # You may not use this product except in compliance with the BSD-2 License. | ||
| # This product may include a number of subcomponents with separate copyright | ||
| # notices and license terms. Your use of these subcomponents is subject to | ||
| # the terms and conditions of the subcomponent's license, as noted in the | ||
| # LICENSE file. | ||
| # | ||
| # SPDX-License-Identifier: BSD-2-Clause | ||
| on: | ||
| workflow_call: | ||
| name: Tests | ||
| jobs: | ||
| get-go-versions: | ||
| name: Collect available Go versions | ||
| runs-on: ubuntu-latest | ||
| outputs: | ||
| matrix: ${{ steps.versions.outputs.matrix }} | ||
| steps: | ||
| - uses: actions/checkout@v3 | ||
| - uses: arnested/go-version-action@b556f8d91b644164318c709d28b9083eaf0c064d | ||
| id: versions | ||
|
|
||
| run: | ||
| strategy: | ||
| fail-fast: false # Keep running if one leg fails. | ||
| matrix: | ||
| os: [ubuntu-latest] # , macos-latest, windows-latest] Enable later so we don't waste github actions resources | ||
| go-version: ${{ fromJSON(needs.get-go-versions.outputs.matrix) }} | ||
| runs-on: ${{ matrix.os }} | ||
| needs: get-go-versions | ||
| steps: | ||
| - name: Checkout code | ||
| uses: actions/checkout@v3 | ||
|
|
||
| - name: Setup - Go ${{ matrix.go-version }} | ||
| uses: actions/setup-go@c4a742cab115ed795e34d4513e2cf7d472deb55f | ||
| with: | ||
| go-version: ${{ matrix.go-version }} | ||
|
|
||
| - name: Run tests | ||
| run: go test -race -covermode atomic -coverprofile='profile.cov' ./... | ||
|
|
||
| - name: Send coverage | ||
| uses: shogo82148/actions-goveralls@31ee804b8576ae49f6dc3caa22591bc5080e7920 | ||
| with: | ||
| path-to-profile: profile.cov | ||
| flag-name: Go-${{ matrix.go-version }} | ||
| parallel: true | ||
|
|
||
| golangci: | ||
| strategy: | ||
| matrix: | ||
| go-version: ${{ fromJSON(needs.get-go-versions.outputs.matrix) }} | ||
| os: [ubuntu-latest] # , macos-latest, windows-latest] Enable later so we don't waste github actions resources | ||
| runs-on: ${{ matrix.os }} | ||
| needs: get-go-versions | ||
| steps: | ||
| - uses: actions/setup-go@c4a742cab115ed795e34d4513e2cf7d472deb55f | ||
| with: | ||
| go-version: ${{ matrix.go-version }} | ||
| - uses: actions/checkout@v3 | ||
| - name: golangci-lint | ||
| uses: golangci/golangci-lint-action@07db5389c99593f11ad7b44463c2d4233066a9b1 | ||
| with: | ||
| version: v1.49 | ||
| args: --timeout 5m --verbose |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| # Copyright 2022-2023 VMware, Inc. | ||
| # | ||
| # This product is licensed to you under the BSD-2 license (the "License"). | ||
| # You may not use this product except in compliance with the BSD-2 License. | ||
| # This product may include a number of subcomponents with separate copyright | ||
| # notices and license terms. Your use of these subcomponents is subject to | ||
| # the terms and conditions of the subcomponent's license, as noted in the | ||
| # LICENSE file. | ||
| # | ||
| # SPDX-License-Identifier: BSD-2-Clause | ||
| run: | ||
| # Lint using Go 1.17, since some linters are disabled by default for Go 1.18 | ||
| # until generics are supported. | ||
| # See https://github.com/golangci/golangci-lint/issues/2649 | ||
| go: "1.17" | ||
|
|
||
| linters: | ||
| disable-all: true | ||
| enable: | ||
| - staticcheck | ||
| - gofmt | ||
| - govet | ||
| - gosimple | ||
| - unused | ||
| - typecheck | ||
| - forbidigo |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,54 @@ | ||
| // Copyright 2022-2023 VMware, Inc. | ||
| // | ||
| // This product is licensed to you under the BSD-2 license (the "License"). | ||
| // You may not use this product except in compliance with the BSD-2 License. | ||
| // This product may include a number of subcomponents with separate copyright | ||
| // notices and license terms. Your use of these subcomponents is subject to | ||
| // the terms and conditions of the subcomponent's license, as noted in the | ||
| // LICENSE file. | ||
| // | ||
| // SPDX-License-Identifier: BSD-2-Clause | ||
|
|
||
| package metadata | ||
|
|
||
| import ( | ||
| "testing" | ||
| "time" | ||
|
|
||
| "github.com/stretchr/testify/assert" | ||
| ) | ||
|
|
||
| func TestRootDefaultValues(t *testing.T) { | ||
| // without setting expiration | ||
| root := Root() | ||
| assert.NotNil(t, root) | ||
| assert.GreaterOrEqual(t, []time.Time{time.Now().UTC()}[0], root.Signed.Expires) | ||
|
|
||
| // setting expiration | ||
| expire := time.Now().AddDate(0, 0, 2).UTC() | ||
| root = Root(expire) | ||
| assert.NotNil(t, root) | ||
| assert.Equal(t, expire, root.Signed.Expires) | ||
|
|
||
| // Type | ||
| assert.Equal(t, ROOT, root.Signed.Type) | ||
|
|
||
| // SpecVersion | ||
| assert.Equal(t, SPECIFICATION_VERSION, root.Signed.SpecVersion) | ||
|
|
||
| // Version | ||
| assert.Equal(t, int64(1), root.Signed.Version) | ||
|
|
||
| // Threshold and KeyIDs for Roles | ||
| for _, role := range []string{ROOT, SNAPSHOT, TARGETS, TIMESTAMP} { | ||
| assert.Equal(t, 1, root.Signed.Roles[role].Threshold) | ||
| assert.Equal(t, []string{}, root.Signed.Roles[role].KeyIDs) | ||
| } | ||
|
|
||
| // Keys | ||
| assert.Equal(t, map[string]*Key{}, root.Signed.Keys) | ||
|
|
||
| // Consistent snapshot | ||
| assert.True(t, root.Signed.ConsistentSnapshot) | ||
|
|
||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.