From 7c4b60548cd9eba5d5f960e8f1b5a1b55355b691 Mon Sep 17 00:00:00 2001 From: muXxer Date: Wed, 25 Oct 2023 12:02:04 +0200 Subject: [PATCH] Add CI workflows and scripts --- .github/workflows/build.yml | 26 ++++ .github/workflows/codeql_analysis.yml | 42 ++++++ .github/workflows/golangci-lint.yml | 23 +++ .gitignore | 22 +++ .golangci.yml | 139 ++++++++++++++++++ LICENSE | 201 ++++++++++++++++++++++++++ README.md | 1 + evilwallet/evilwallet.go | 4 +- evilwallet/output_manager.go | 4 +- scripts/get_hive.sh | 21 +++ scripts/go_mod_tidy.sh | 6 + 11 files changed, 485 insertions(+), 4 deletions(-) create mode 100644 .github/workflows/build.yml create mode 100644 .github/workflows/codeql_analysis.yml create mode 100644 .github/workflows/golangci-lint.yml create mode 100644 .gitignore create mode 100644 .golangci.yml create mode 100644 LICENSE create mode 100644 README.md create mode 100755 scripts/get_hive.sh create mode 100755 scripts/go_mod_tidy.sh diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml new file mode 100644 index 0000000..0db6a76 --- /dev/null +++ b/.github/workflows/build.yml @@ -0,0 +1,26 @@ +name: Build evil-tools + +on: + pull_request: + paths-ignore: + - 'scripts/**' + +jobs: + build: + name: Build evil-tools + runs-on: self-hosted + steps: + - name: Set up Go + uses: actions/setup-go@v4 + with: + go-version: "1.21" + id: go + + - name: Print Go version + run: go version + + - name: Check out code into the Go module directory + uses: actions/checkout@v3 + + - name: Build evil-tools + run: go build -v . diff --git a/.github/workflows/codeql_analysis.yml b/.github/workflows/codeql_analysis.yml new file mode 100644 index 0000000..e184698 --- /dev/null +++ b/.github/workflows/codeql_analysis.yml @@ -0,0 +1,42 @@ + +name: "CodeQL" + +on: + # Run this security check every day at 03:00 to find potential new vulnerabilities in the develop branch + schedule: + - cron: "0 3 * * *" + +jobs: + analyze: + name: Analyze + runs-on: self-hosted + permissions: + actions: read + contents: read + security-events: write + + strategy: + fail-fast: false + matrix: + language: [ 'go' ] + + steps: + - name: Checkout repository + uses: actions/checkout@v3 + with: + ref: develop + + # Initializes the CodeQL tools for scanning. + - name: Initialize CodeQL + uses: github/codeql-action/init@v2 + with: + languages: ${{ matrix.language }} + queries: security-and-quality + + # 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 + + - name: Perform CodeQL Analysis + uses: github/codeql-action/analyze@v2 diff --git a/.github/workflows/golangci-lint.yml b/.github/workflows/golangci-lint.yml new file mode 100644 index 0000000..1836018 --- /dev/null +++ b/.github/workflows/golangci-lint.yml @@ -0,0 +1,23 @@ +name: GolangCIlint + +on: + pull_request: + paths-ignore: + - 'scripts/**' + +jobs: + golangci-lint: + name: GolangCI-Lint + runs-on: self-hosted + steps: + - name: Check out code into the Go module directory + uses: actions/checkout@v3 + + - name: golangci-lint + uses: reviewdog/action-golangci-lint@v2 + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + golangci_lint_flags: "--timeout=10m" + reporter: github-pr-check + filter_mode: nofilter + fail_on_error: true diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..6f955cb --- /dev/null +++ b/.gitignore @@ -0,0 +1,22 @@ +# Binaries for programs and plugins +evil-tools +*.exe +*.exe~ +*.dll +*.so +*.dylib + +# Test binary, build with `go test -c` +*.test + +# Output of the go coverage tool, specifically when used with LiteIDE +*.out + +# IDE related files +.vscode/ +.idea/ +go.work +go.work.sum + +# OSX related files +.DS_Store diff --git a/.golangci.yml b/.golangci.yml new file mode 100644 index 0000000..993ebfa --- /dev/null +++ b/.golangci.yml @@ -0,0 +1,139 @@ +run: + tests: true + skip-dirs: + - scripts + skip-files: + - ".*_test.go$" + - "testframework.go" + +linters-settings: + gofmt: + simplify: true + goimports: + local-prefixes: github.com/iotaledger + gocyclo: + min-complexity: 15 + govet: + check-shadowing: false + misspell: + locale: US + staticcheck: + checks: ["all"] + nlreturn: + block-size: 2 + stylecheck: + initialisms: ["ACL", "API", "ASCII", "CPU", "CSS", "DNS", "EOF", "GUID", "HTML", "HTTP", "HTTPS", "ID", "IP", "JSON", "QPS", "RAM", "RPC", "SLA", "SMTP", "SQL", "SSH", "TCP", "TLS", "TTL", "UDP", "UI", "GID", "UID", "UUID", "URI", "URL", "UTF8", "VM", "XML", "XMPP", "XSRF", "XSS", "SIP", "RTP", "AMQP", "DB", "TS"] + depguard: + rules: + main: + deny: + - pkg: "errors" + desc: Should be replaced with "github.com/iotaledger/hive.go/ierrors" package + - pkg: "golang.org/x/xerrors" + desc: Should be replaced with "github.com/iotaledger/hive.go/ierrors" package + - pkg: "github.com/pkg/errors" + desc: Should be replaced with "github.com/iotaledger/hive.go/ierrors" package + +linters: + # Disable all linters. + disable-all: true + # Enable specific linter + enable: + - errcheck + - gosimple + - govet + - ineffassign + - staticcheck + - typecheck + - unused + - asasalint + - asciicheck + - bidichk + - bodyclose + #- containedctx + - contextcheck + - decorder + - depguard + - dogsled + #- dupl + - durationcheck + - errchkjson + - errname + #- errorlint + - execinquery + #- exhaustive + #- exhaustruct + - exportloopref + - forcetypeassert + - goconst + #- gocritic + - godot + #- godox + #- goerr113 + - gofmt + - goheader + - goimports + #- gomnd + #- gomoddirectives + - gomodguard + - goprintffuncname + - gosec + - grouper + - importas + #- interfacer + #- makezero + #- maligned + - misspell + #- nakedret + - nilerr + - nilnil + - nlreturn + - noctx + #- nonamedreturns + #- nosnakecase + #- nosprintfhostport + - prealloc + - predeclared + - promlinter + - revive + #- scopelint + - sqlclosecheck + - stylecheck + - tagliatelle + - tenv + #- testpackage + #- thelper + - tparallel + - unconvert + - unparam + - usestdlibvars + #- varnamelen + +issues: + # Maximum issues count per one linter. + # Set to 0 to disable. + # Default: 50 + max-issues-per-linter: 0 + # Maximum count of issues with the same text. + # Set to 0 to disable. + # Default: 3 + max-same-issues: 0 + #exclude: + # - 'Error return value of .((os\.)?std(out|err)\..*|.*Close|.*Flush|os\.Remove(All)?|.*print(f|ln)?|os\.(Un)?Setenv). is not checked' # errcheck + # - "err113: do not define dynamic errors, use wrapped static errors instead:" # goerr113 + # - "type name will be used as [0-9A-Za-z_.]+ by other packages, and that stutters; consider calling this" # golint + # - "Potential file inclusion via variable" # gosec + # - "G404: Use of weak random number generator" # gosec + # - "Subprocess launch(ed with variable|ing should be audited)" # gosec + # - "Use of unsafe calls should be audited" # gosec + # - "G108: Profiling endpoint is automatically exposed on /debug/pprof" # gosec + # - "(Expect directory permissions to be 0750 or less|Expect file permissions to be 0600 or less)" # gosec + # - "G101: Potential hardcoded credentials" # gosec + # - "(G104|G307)" # gosec Duplicated errcheck checks. + # - "`[0-9A-Za-z_.]+` - `[0-9A-Za-z_.]+` always receives `[0-9A-Za-z_.]+`" # unparam + # - "should have comment .*or be unexported" # revive + # - "exported: comment on exported" # revive + # - "package-comments: package comment should be of the form" # revive + # - "blank-imports" # revive + # - "var-naming: don't use leading k in Go names;" #revive + # - 'shadow: declaration of "err"' # govet diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..adefdca --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2023 IOTA Foundation + + 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. diff --git a/README.md b/README.md new file mode 100644 index 0000000..1acc049 --- /dev/null +++ b/README.md @@ -0,0 +1 @@ +# evil-tools \ No newline at end of file diff --git a/evilwallet/evilwallet.go b/evilwallet/evilwallet.go index 10ccb6f..5e1d36a 100644 --- a/evilwallet/evilwallet.go +++ b/evilwallet/evilwallet.go @@ -437,10 +437,10 @@ func printTransaction(tx *iotago.SignedTransaction) string { } txDetails += fmt.Sprintln("Allotments:") for _, allotment := range tx.Transaction.Allotments { - txDetails += fmt.Sprintf("AllotmentID: %s, value: %d\n", allotment.AccountID, allotment.Value) + txDetails += fmt.Sprintf("AllotmentID: %s, value: %d\n", allotment.AccountID, allotment.Mana) } for _, allotment := range tx.Transaction.TransactionEssence.Allotments { - txDetails += fmt.Sprintf("al 2 AllotmentID: %s, value: %d\n", allotment.AccountID, allotment.Value) + txDetails += fmt.Sprintf("al 2 AllotmentID: %s, value: %d\n", allotment.AccountID, allotment.Mana) } return txDetails diff --git a/evilwallet/output_manager.go b/evilwallet/output_manager.go index 6f995a7..0478245 100644 --- a/evilwallet/output_manager.go +++ b/evilwallet/output_manager.go @@ -315,13 +315,13 @@ func (o *OutputManager) AwaitTransactionToBeAccepted(txID iotago.TransactionID, if resp.BlockState == apimodels.BlockStateFailed.String() || resp.BlockState == apimodels.BlockStateRejected.String() { failureReason, _, _ := apimodels.BlockFailureReasonFromBytes(lo.PanicOnErr(resp.BlockFailureReason.Bytes())) - return ierrors.Errorf("tx %s failed because block failure: %s", txID, failureReason) + return ierrors.Errorf("tx %s failed because block failure: %d", txID, failureReason) } if resp.TransactionState == apimodels.TransactionStateFailed.String() { failureReason, _, _ := apimodels.TransactionFailureReasonFromBytes(lo.PanicOnErr(resp.TransactionFailureReason.Bytes())) - return ierrors.Errorf("transaction %s failed: %s", txID, failureReason) + return ierrors.Errorf("transaction %s failed: %d", txID, failureReason) } confirmationState := resp.TransactionState diff --git a/scripts/get_hive.sh b/scripts/get_hive.sh new file mode 100755 index 0000000..9687492 --- /dev/null +++ b/scripts/get_hive.sh @@ -0,0 +1,21 @@ +#!/bin/bash + +COMMIT=$1 +if [ -z "$COMMIT" ] +then + echo "ERROR: no commit hash given!" + exit 1 +fi + +HIVE_MODULES=$(grep -E "^\sgithub.com/iotaledger/hive.go" "go.mod" | awk '{print $1}') +for dependency in $HIVE_MODULES +do + echo "go get $dependency@$COMMIT..." + go get "$dependency@$COMMIT" >/dev/null +done + +# Run go mod tidy +echo "Running go mod tidy..." +pushd $(dirname $0) +./go_mod_tidy.sh +popd diff --git a/scripts/go_mod_tidy.sh b/scripts/go_mod_tidy.sh new file mode 100755 index 0000000..937a740 --- /dev/null +++ b/scripts/go_mod_tidy.sh @@ -0,0 +1,6 @@ +#!/bin/bash +pushd ./.. + +go mod tidy + +popd \ No newline at end of file