From 56ee12655ee090e8ee62d1db6c893cbbdcee6dea Mon Sep 17 00:00:00 2001 From: Anton Novojilov Date: Sun, 21 Jul 2024 08:05:12 +0300 Subject: [PATCH 1/5] Add the first prototype --- .github/CODE_OF_CONDUCT.md | 42 ++++++ .github/CONTRIBUTING.md | 19 +++ .github/ISSUE_TEMPLATE/bug.yml | 54 +++++++ .github/ISSUE_TEMPLATE/config.yml | 1 + .github/ISSUE_TEMPLATE/question.yml | 20 +++ .github/ISSUE_TEMPLATE/suggestion.yml | 43 ++++++ .github/PULL_REQUEST_TEMPLATE.md | 24 +++ .github/dependabot.yml | 36 +++++ .github/images/card.svg | 1 + .github/images/license.svg | 1 + .github/workflows/ci.yml | 82 +++++++++++ .github/workflows/codeql.yml | 33 +++++ .typos.toml | 2 + LICENSE | 201 ++++++++++++++++++++++++++ Makefile | 102 +++++++++++++ README.md | 29 +++- SECURITY.md | 36 +++++ ycfunc.go | 176 ++++++++++++++++++++++ 18 files changed, 900 insertions(+), 2 deletions(-) create mode 100644 .github/CODE_OF_CONDUCT.md create mode 100644 .github/CONTRIBUTING.md create mode 100644 .github/ISSUE_TEMPLATE/bug.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/question.yml create mode 100644 .github/ISSUE_TEMPLATE/suggestion.yml create mode 100644 .github/PULL_REQUEST_TEMPLATE.md create mode 100644 .github/dependabot.yml create mode 100644 .github/images/card.svg create mode 100644 .github/images/license.svg create mode 100644 .github/workflows/ci.yml create mode 100644 .github/workflows/codeql.yml create mode 100644 .typos.toml create mode 100644 LICENSE create mode 100644 Makefile create mode 100644 SECURITY.md create mode 100644 ycfunc.go diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..45abf3d --- /dev/null +++ b/.github/CODE_OF_CONDUCT.md @@ -0,0 +1,42 @@ +# Contributor Code of Conduct + +As contributors and maintainers of this project, and in the interest of +fostering an open and welcoming community, we pledge to respect all people who +contribute through reporting issues, posting feature requests, updating +documentation, submitting pull requests or patches, and other activities. + +We are committed to making participation in this project a harassment-free +experience for everyone, regardless of level of experience, gender, gender +identity and expression, sexual orientation, disability, personal appearance, +body size, race, ethnicity, age, religion, or nationality. + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery +* Personal attacks +* Trolling or insulting/derogatory comments +* Public or private harassment +* Publishing other's private information, such as physical or electronic + addresses, without explicit permission +* Other unethical or unprofessional conduct + +Project maintainers have the right and responsibility to remove, edit, or +reject comments, commits, code, wiki edits, issues, and other contributions +that are not aligned to this Code of Conduct, or to ban temporarily or +permanently any contributor for other behaviors that they deem inappropriate, +threatening, offensive, or harmful. + +By adopting this Code of Conduct, project maintainers commit themselves to +fairly and consistently applying these principles to every aspect of managing +this project. Project maintainers who do not follow or enforce the Code of +Conduct may be permanently removed from the project team. + +This Code of Conduct applies both within project spaces and in public spaces +when an individual is representing the project or its community. + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported by contacting a project maintainer at `conduct@essentialkaos.com`. All +complaints will be reviewed and investigated and will result in a response that +is deemed necessary and appropriate to the circumstances. Maintainers are +obligated to maintain confidentiality with regard to the reporter of an +incident. diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000..d7da3fb --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,19 @@ +# Contributing Guidelines + +**IMPORTANT! Contribute your code only if you have an excellent understanding of project idea and all existing code base. Otherwise, a nicely formatted issue will be more helpful to us.** + +### Issues + +1. Provide product version where the problem was found; +2. Provide info about your environment; +3. Provide detailed info about your problem; +4. Provide steps to reproduce the problem; +5. Provide actual and expected results. + +### Code + +1. Check your code **before** creating pull request; +2. If tests are present in a project, add tests for your code; +3. Add inline documentation for your code; +4. Apply code style used throughout the project; +5. Create your pull request to `develop` branch (_pull requests to other branches are not allowed_). diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml new file mode 100644 index 0000000..582d196 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -0,0 +1,54 @@ +name: ❗ Bug Report +description: File a bug report +title: "[Bug]: " +labels: ["issue • bug"] +assignees: + - andyone + +body: + - type: markdown + attributes: + value: | + > [!IMPORTANT] + > Before you open an issue, search GitHub Issues for a similar bug reports. If so, please add a 👍 reaction to the existing issue. + + - type: dropdown + id: version + attributes: + label: Install tools + description: How did you install this application + options: + - From Sources + default: 0 + validations: + required: true + + - type: textarea + attributes: + label: Steps to reproduce + description: Short guide on how to reproduce this problem on our site + placeholder: | + 1. [First Step] + 2. [Second Step] + 3. [and so on...] + validations: + required: true + + - type: textarea + attributes: + label: Expected behavior + description: What you expected to happen + validations: + required: true + + - type: textarea + attributes: + label: Actual behavior + description: What actually happened + validations: + required: true + + - type: textarea + attributes: + label: Additional info + description: Include gist of relevant config, logs, etc. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..3ba13e0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1 @@ +blank_issues_enabled: false diff --git a/.github/ISSUE_TEMPLATE/question.yml b/.github/ISSUE_TEMPLATE/question.yml new file mode 100644 index 0000000..f8e4c80 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.yml @@ -0,0 +1,20 @@ +name: ❓ Question +description: Question about application, configuration or code +title: "[Question]: " +labels: ["issue • question"] +assignees: + - andyone + +body: + - type: markdown + attributes: + value: | + > [!IMPORTANT] + > Before you open an issue, search GitHub Issues for a similar question. If so, please add a 👍 reaction to the existing issue. + + - type: textarea + attributes: + label: Question + description: Detailed question + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/suggestion.yml b/.github/ISSUE_TEMPLATE/suggestion.yml new file mode 100644 index 0000000..39c69e0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/suggestion.yml @@ -0,0 +1,43 @@ +name: ➕ Suggestion +description: Suggest new feature or improvement +title: "[Suggestion]: " +labels: ["issue • suggestion"] +assignees: + - andyone + +body: + - type: markdown + attributes: + value: | + > [!IMPORTANT] + > Before you open an issue, search GitHub Issues for a similar feature requests. If so, please add a 👍 reaction to the existing issue. + > + > Opening a feature request kicks off a discussion. Requests may be closed if we're not actively planning to work on them. + + - type: textarea + attributes: + label: Proposal + description: Description of the feature + validations: + required: true + + - type: textarea + attributes: + label: Current behavior + description: What currently happens + validations: + required: true + + - type: textarea + attributes: + label: Desired behavior + description: What you would like to happen + validations: + required: true + + - type: textarea + attributes: + label: Use case + description: Why is this important (helps with prioritizing requests) + validations: + required: true diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..e7814b8 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,24 @@ +### What did you implement: + +Closes #XXXXX + +### How did you implement it: + +... + +### How can we verify it: + +... + +### TODO's: + +- [ ] Write tests +- [ ] Write documentation +- [ ] Check that there aren't other open pull requests for the same issue/feature +- [ ] Format your source code by `make fmt` +- [ ] Provide verification config / commands +- [ ] Enable "Allow edits from maintainers" for this PR +- [ ] Update the messages below + +**Is this ready for review?:** No +**Is it a breaking change?:** No diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 0000000..d0ad1de --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,36 @@ +version: 2 + +updates: + - package-ecosystem: "gomod" + directory: "/" + target-branch: "develop" + schedule: + interval: "daily" + timezone: "Europe/London" + time: "03:00" + labels: + - "PR • MAINTENANCE" + assignees: + - "andyone" + reviewers: + - "andyone" + groups: + all: + applies-to: version-updates + update-types: + - "minor" + - "patch" + + - package-ecosystem: "github-actions" + directory: "/" + target-branch: "develop" + schedule: + interval: "daily" + timezone: "Europe/London" + time: "04:00" + labels: + - "PR • MAINTENANCE" + assignees: + - "andyone" + reviewers: + - "andyone" diff --git a/.github/images/card.svg b/.github/images/card.svg new file mode 100644 index 0000000..35229bf --- /dev/null +++ b/.github/images/card.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/.github/images/license.svg b/.github/images/license.svg new file mode 100644 index 0000000..8990e77 --- /dev/null +++ b/.github/images/license.svg @@ -0,0 +1 @@ +license: Apache-2.0licenseApache-2.0 \ No newline at end of file diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000..06e544c --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,82 @@ +name: CI + +on: + push: + branches: [master, develop] + pull_request: + branches: [master] + workflow_dispatch: + inputs: + force_run: + description: 'Force workflow run' + required: true + type: choice + options: [yes, no] + +permissions: + actions: read + contents: read + statuses: write + +concurrency: + group: ${{ github.workflow }}-${{ github.ref }} + cancel-in-progress: true + +jobs: + Go: + name: Go + runs-on: ubuntu-latest + + strategy: + matrix: + go: [ '1.21.x' ] + + steps: + - name: Checkout + uses: actions/checkout@v4 + + - name: Set up Go + uses: actions/setup-go@v5 + with: + go-version: ${{ matrix.go }} + + - name: Download dependencies + run: make deps + + - name: Run tests + run: make all + + Perfecto: + name: Perfecto + runs-on: ubuntu-latest + + needs: Go + + steps: + - name: Code checkout + uses: actions/checkout@v4 + + - name: Login to GitHub Container Registry + uses: docker/login-action@v3 + with: + registry: ghcr.io + username: ${{ github.actor }} + password: ${{ secrets.GITHUB_TOKEN }} + + - name: Check specs with Perfecto + uses: essentialkaos/perfecto-action@v2 + with: + files: common/{{SHORT_NAME}}.spec + + Typos: + name: Typos + runs-on: ubuntu-latest + + needs: Go + + steps: + - name: Checkout + uses: actions/checkout@v4 + + - name: Check spelling + uses: crate-ci/typos@master diff --git a/.github/workflows/codeql.yml b/.github/workflows/codeql.yml new file mode 100644 index 0000000..bfc4df5 --- /dev/null +++ b/.github/workflows/codeql.yml @@ -0,0 +1,33 @@ +name: "CodeQL" + +on: + push: + branches: [master, develop] + pull_request: + branches: [master] + schedule: + - cron: '0 3 * * */2' + +permissions: + security-events: write + actions: read + contents: read + +jobs: + analyse: + name: Analyse + runs-on: ubuntu-latest + + steps: + - name: Checkout repository + uses: actions/checkout@v4 + with: + fetch-depth: 2 + + - name: Initialize CodeQL + uses: github/codeql-action/init@v3 + with: + languages: go + + - name: Perform CodeQL Analysis + uses: github/codeql-action/analyze@v3 diff --git a/.typos.toml b/.typos.toml new file mode 100644 index 0000000..55aead8 --- /dev/null +++ b/.typos.toml @@ -0,0 +1,2 @@ +[files] +extend-exclude = ["go.sum"] diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..4215607 --- /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 2020 ESSENTIAL KAOS + + 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/Makefile b/Makefile new file mode 100644 index 0000000..cc4ad75 --- /dev/null +++ b/Makefile @@ -0,0 +1,102 @@ +################################################################################ + +ifdef VERBOSE ## Print verbose information (Flag) +VERBOSE_FLAG = -v +endif + +COMPAT ?= 1.19 +MAKEDIR = $(dir $(realpath $(firstword $(MAKEFILE_LIST)))) +GITREV ?= $(shell test -s $(MAKEDIR)/.git && git rev-parse --short HEAD) + +################################################################################ + +.DEFAULT_GOAL := help +.PHONY = fmt vet all pack clean deps update init vendor mod-init mod-update mod-download mod-vendor help + +################################################################################ + +all: ## Build binary + @echo "Building function…" + @go build ycfunc.go + +pack: ## Pack function into zip + @echo "Packing YC function to zip…" + @go build ycfunc.go && rm -f ycfunc + @zip funky -r "ycfunc.go" go.* + +init: mod-init ## Initialize new module + +deps: mod-download ## Download dependencies + +update: mod-update ## Update dependencies to the latest versions + +vendor: mod-vendor ## Make vendored copy of dependencies + +mod-init: + @echo "[1/2] Modules initialization…" +ifdef MODULE_PATH ## Module path for initialization (String) + @go mod init $(MODULE_PATH) +else + @go mod init +endif + + @echo "[2/2] Dependencies cleanup…" +ifdef COMPAT ## Compatible Go version (String) + @go mod tidy $(VERBOSE_FLAG) -compat=$(COMPAT) -go=$(COMPAT) +else + @go mod tidy $(VERBOSE_FLAG) +endif + +mod-update: + @echo "[1/4] Updating dependencies…" +ifdef UPDATE_ALL ## Update all dependencies (Flag) + @go get -u $(VERBOSE_FLAG) all +else + @go get -u $(VERBOSE_FLAG) ./... +endif + + @echo "[2/4] Stripping toolchain info…" + @grep -q 'toolchain ' go.mod && go mod edit -toolchain=none || : + + @echo "[3/4] Dependencies cleanup…" +ifdef COMPAT + @go mod tidy $(VERBOSE_FLAG) -compat=$(COMPAT) +else + @go mod tidy $(VERBOSE_FLAG) +endif + + @echo "[4/4] Updating vendored dependencies…" + @test -d vendor && rm -rf vendor && go mod vendor $(VERBOSE_FLAG) || : + +mod-download: + @echo "Downloading dependencies…" + @go mod download + +mod-vendor: + @echo "Vendoring dependencies…" + @rm -rf vendor && go mod vendor $(VERBOSE_FLAG) || : + +fmt: ## Format source code with gofmt + @echo "Formatting sources…" + @find . -name "*.go" -exec gofmt -s -w {} \; + +vet: ## Runs 'go vet' over sources + @echo "Running 'go vet' over sources…" + @go vet -composites=false -printfuncs=LPrintf,TLPrintf,TPrintf,log.Debug,log.Info,log.Warn,log.Error,log.Critical,log.Print ./... + +clean: ## Remove generated files + @echo "Removing built binaries…" + @rm -f ycfunc funky.zip + +help: ## Show this info + @echo -e '\n\033[1mTargets:\033[0m\n' + @grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) \ + | awk 'BEGIN {FS = ":.*?## "}; {printf " \033[33m%-9s\033[0m %s\n", $$1, $$2}' + @echo -e '\n\033[1mVariables:\033[0m\n' + @grep -E '^ifdef [A-Z_]+ .*?## .*$$' $(abspath $(lastword $(MAKEFILE_LIST))) \ + | sed 's/ifdef //' \ + | awk 'BEGIN {FS = " .*?## "}; {printf " \033[32m%-11s\033[0m %s\n", $$1, $$2}' + @echo -e '' + @echo -e '\033[90mGenerated by GoMakeGen 3.0.5\033[0m\n' + +################################################################################ diff --git a/README.md b/README.md index 182db9d..aa1e396 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,27 @@ -# funky -Simple Yandex.Cloud function for transforming timer triggers into HTTP requests +

+ +

+ GitHub Actions CI Status + GitHub Actions CodeQL Status + +

+ +
+ +`funky` is a simple Yandex.Cloud function for transforming [timer triggers](https://yandex.cloud/en/docs/serverless-containers/concepts/trigger/timer) into HTTP requests. + +### Configuration + +Entrypoint: `ycfunc.Timer` + +#### Environment + +| Variable | Required | Description | +|----------|----------|-------------| +| `ASYNC` | No | _Send [async requests](https://yandex.cloud/en/docs/functions/concepts/function-invoke-async)_ | + +#### Required service roles + +- `serverless.containers.invoker` + +

diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000..f42c71e --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,36 @@ +# Security Policies and Procedures + +This document outlines security procedures and general policies for all +ESSENTIAL KAOS projects. + + * [Reporting a Bug](#reporting-a-bug) + * [Disclosure Policy](#disclosure-policy) + +## Reporting a Bug + +The ESSENTIAL KAOS team and community take all security bugs in our projects +very seriously. Thank you for improving the security of our project. We +appreciate your efforts and responsible disclosure and will make every effort +to acknowledge your contributions. + +Report security bugs by emailing our security team at security@essentialkaos.com. + +The security team will acknowledge your email within 48 hours and will send a +more detailed response within 48 hours, indicating the next steps in handling +your report. After the initial reply to your report, the security team will +endeavor to keep you informed of the progress towards a fix and full +announcement, and may ask for additional information or guidance. + +Report security bugs in third-party dependencies to the person or team +maintaining the dependencies. + +## Disclosure Policy + +When the security team receives a security bug report, they will assign it to a +primary handler. This person will coordinate the fix and release process, +involving the following steps: + + * Confirm the problem and determine the affected versions; + * Audit code to find any similar potential problems; + * Prepare fixes for all releases still under maintenance. These fixes will be + released as fast as possible. diff --git a/ycfunc.go b/ycfunc.go new file mode 100644 index 0000000..fefff00 --- /dev/null +++ b/ycfunc.go @@ -0,0 +1,176 @@ +package main + +// ////////////////////////////////////////////////////////////////////////////////// // +// // +// Copyright (c) 2024 ESSENTIAL KAOS // +// Apache License, Version 2.0 // +// // +// ////////////////////////////////////////////////////////////////////////////////// // + +import ( + "context" + "fmt" + "net/url" + "os" + "strconv" + "time" + + "github.com/essentialkaos/ek/v13/log" + "github.com/essentialkaos/ek/v13/req" +) + +// ////////////////////////////////////////////////////////////////////////////////// // + +// VER is current function version +const VER = "0.0.1" + +// TIMER_EVENT_TYPE is timer event type +const TIMER_EVENT_TYPE = "yandex.cloud.events.serverless.triggers.TimerMessage" + +// ////////////////////////////////////////////////////////////////////////////////// // + +type Trigger struct { + Messages []*Message `json:"messages"` +} + +type Message struct { + Metadata *Metadata `json:"event_metadata"` + Details *Details `json:"details"` +} + +type Metadata struct { + EventType string `json:"event_type"` + CreatedAt string `json:"created_at"` +} + +type Details struct { + TriggerID string `json:"trigger_id"` + Payload string `json:"payload"` +} + +// ////////////////////////////////////////////////////////////////////////////////// // + +// main is used for check for compilation errors +func main() { + return +} + +// ////////////////////////////////////////////////////////////////////////////////// // + +// Timer is handler for timer trigger +func Timer(ctx context.Context, trigger *Trigger) error { + req.SetUserAgent("YCFunction|funky", VER) + + log.Global.UseJSON = true + log.Global.WithCaller = true + + defer log.Flush() + + log.Info("Got trigger event") + + if !validatePayload(trigger) { + return fmt.Errorf("Error while trigger event validation") + } + + var lf log.Fields + + invURL := trigger.Payload() + async := os.Getenv("ASYNC") != "" + + r := req.Request{ + URL: invURL, + AutoDiscard: true, + Headers: req.Headers{ + "X-Funky-Version": VER, + "Trigger-Source": "funky", + "Trigger-Id": trigger.ID(), + "Trigger-Ts": trigger.Timestamp(), + }, + } + + if async { + r.Query = req.Query{"integration": "async"} + } + + lf.Add(log.F{"url", invURL}, log.F{"async", async}) + log.Info("Sending HTTP request", lf) + + resp, err := r.Get() + + if err != nil { + log.Error("Error while sending request: %v", err, lf) + return fmt.Errorf("Error while sending request") + } + + lf.Add(log.F{"status-code", resp.StatusCode}) + + if resp.StatusCode != req.STATUS_OK { + log.Error("Server returned non-ok status code %d", lf) + return fmt.Errorf("Error while processing response") + } + + log.Info("Request successfully sent", lf) + + return nil +} + +// ////////////////////////////////////////////////////////////////////////////////// // + +// Payload returns payload from trigger data +func (d *Trigger) Payload() string { + return d.Messages[0].Details.Payload +} + +// ID returns trigger ID +func (d *Trigger) ID() string { + return d.Messages[0].Details.TriggerID +} + +// Timestamp returns trigger timestamp +func (d *Trigger) Timestamp() string { + created, _ := time.Parse(time.RFC3339Nano, d.Messages[0].Metadata.CreatedAt) + return strconv.FormatInt(created.UnixMilli(), 10) +} + +// ////////////////////////////////////////////////////////////////////////////////// // + +// validatePayload validates trigger payload +func validatePayload(trigger *Trigger) bool { + switch { + case trigger == nil: + log.Error("Trigger data is nil") + return false + + case len(trigger.Messages) == 0: + log.Error("No messages in trigger event") + return false + + case trigger.Messages[0].Metadata == nil: + log.Error("No metadata in message #0") + return false + + case trigger.Messages[0].Metadata.EventType != TIMER_EVENT_TYPE: + log.Error( + "Unsupported event type", + log.F{"event-type", trigger.Messages[0].Metadata.EventType}, + ) + return false + + case trigger.Messages[0].Details == nil: + log.Error("No details in message #0") + return false + + case trigger.Messages[0].Details.Payload == "": + log.Error("Payload is empty") + return false + } + + _, err := url.Parse(trigger.Messages[0].Details.Payload) + + if err != nil { + log.Error("Can't parse URL in payload: %v", err) + return false + } + + return true +} From 4b22beee7eb6c1a439e3abb349f9c01fcd6835eb Mon Sep 17 00:00:00 2001 From: Anton Novojilov Date: Sun, 21 Jul 2024 08:06:30 +0300 Subject: [PATCH 2/5] Add the first prototype --- go.mod | 5 +++++ go.sum | 7 +++++++ 2 files changed, 12 insertions(+) create mode 100644 go.mod create mode 100644 go.sum diff --git a/go.mod b/go.mod new file mode 100644 index 0000000..4131dcb --- /dev/null +++ b/go.mod @@ -0,0 +1,5 @@ +module github.com/essentialkaos/funky + +go 1.19 + +require github.com/essentialkaos/ek/v13 v13.1.0 diff --git a/go.sum b/go.sum new file mode 100644 index 0000000..17ed3ab --- /dev/null +++ b/go.sum @@ -0,0 +1,7 @@ +github.com/essentialkaos/check v1.4.0 h1:kWdFxu9odCxUqo1NNFNJmguGrDHgwi3A8daXX1nkuKk= +github.com/essentialkaos/ek/v13 v13.1.0 h1:k0X7805R2z5QVBCYzGgApWosnpmBdb+00B4rc2tEGVA= +github.com/essentialkaos/ek/v13 v13.1.0/go.mod h1:RVf1NpNyK04xkBJ3NTUD1wNLWemY9/naVD4iEVjU2fA= +github.com/kr/pretty v0.3.1 h1:flRD4NNwYAUpkphVc1HcthR4KEIFJ65n8Mw5qdRn3LE= +github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY= +github.com/rogpeppe/go-internal v1.11.0 h1:cWPaGQEPrBb5/AsnsZesgZZ9yb1OQ+GOISoDNXVBh4M= +golang.org/x/sys v0.22.0 h1:RI27ohtqKCnwULzJLqkv897zojh5/DwS/ENaMzUOaWI= From 86daeac78b86b644b49e5d4b9e630e414d7e03e9 Mon Sep 17 00:00:00 2001 From: Anton Novojilov Date: Sun, 21 Jul 2024 08:08:57 +0300 Subject: [PATCH 3/5] Fix CI workflow --- .github/workflows/ci.yml | 22 ---------------------- 1 file changed, 22 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 06e544c..92cb15d 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -46,28 +46,6 @@ jobs: - name: Run tests run: make all - Perfecto: - name: Perfecto - runs-on: ubuntu-latest - - needs: Go - - steps: - - name: Code checkout - uses: actions/checkout@v4 - - - name: Login to GitHub Container Registry - uses: docker/login-action@v3 - with: - registry: ghcr.io - username: ${{ github.actor }} - password: ${{ secrets.GITHUB_TOKEN }} - - - name: Check specs with Perfecto - uses: essentialkaos/perfecto-action@v2 - with: - files: common/{{SHORT_NAME}}.spec - Typos: name: Typos runs-on: ubuntu-latest From ee06738f18ff489ba09d8acb30b625fd393320a5 Mon Sep 17 00:00:00 2001 From: Anton Novojilov Date: Sun, 21 Jul 2024 08:17:33 +0300 Subject: [PATCH 4/5] Improve README --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index aa1e396..2a0be3a 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@

- GitHub Actions CI Status + GitHub Actions CI Status GitHub Actions CodeQL Status

From 52a6bfaae4993d801c111daf30df158b73ad62fd Mon Sep 17 00:00:00 2001 From: Anton Novojilov Date: Sun, 21 Jul 2024 08:28:38 +0300 Subject: [PATCH 5/5] Update User-Agent --- ycfunc.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ycfunc.go b/ycfunc.go index fefff00..3b70466 100644 --- a/ycfunc.go +++ b/ycfunc.go @@ -59,7 +59,7 @@ func main() { // Timer is handler for timer trigger func Timer(ctx context.Context, trigger *Trigger) error { - req.SetUserAgent("YCFunction|funky", VER) + req.SetUserAgent("funky", VER) log.Global.UseJSON = true log.Global.WithCaller = true