From 119e4047b05e84aa5f506aa93a66919b6bcd25b6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Iv=C3=A1n=20SZKIBA?= Date: Mon, 17 Jun 2024 08:16:15 +0200 Subject: [PATCH] initial version --- .github/workflows/lint.yml | 32 ++ .github/workflows/release.yml | 28 ++ .github/workflows/test.yml | 45 +++ .gitignore | 6 + .golangci.yml | 133 +++++++ .goreleaser.yaml | 38 ++ CODEOWNERS | 1 + LICENSE | 661 ++++++++++++++++++++++++++++++++++ README.md | 391 ++++++++++++++++++++ bin_unix.go | 8 + bin_windows.go | 8 + build.go | 90 +++++ cmd/cmd.go | 124 +++++++ cmd/help.md | 1 + cmd/k6exec/error.go | 49 +++ cmd/k6exec/main.go | 39 ++ command.go | 40 ++ doc.go | 2 + examples/device.js | 14 + examples/script.js | 11 + examples/user.js | 14 + go.mod | 20 + go.sum | 39 ++ module.go | 105 ++++++ options.go | 39 ++ tools/gendoc/main.go | 16 + 26 files changed, 1954 insertions(+) create mode 100644 .github/workflows/lint.yml create mode 100644 .github/workflows/release.yml create mode 100644 .github/workflows/test.yml create mode 100644 .gitignore create mode 100644 .golangci.yml create mode 100644 .goreleaser.yaml create mode 100644 CODEOWNERS create mode 100644 LICENSE create mode 100644 README.md create mode 100644 bin_unix.go create mode 100644 bin_windows.go create mode 100644 build.go create mode 100644 cmd/cmd.go create mode 100644 cmd/help.md create mode 100644 cmd/k6exec/error.go create mode 100644 cmd/k6exec/main.go create mode 100644 command.go create mode 100644 doc.go create mode 100644 examples/device.js create mode 100644 examples/script.js create mode 100644 examples/user.js create mode 100644 go.mod create mode 100644 go.sum create mode 100644 module.go create mode 100644 options.go create mode 100644 tools/gendoc/main.go diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml new file mode 100644 index 0000000..17b6b67 --- /dev/null +++ b/.github/workflows/lint.yml @@ -0,0 +1,32 @@ +name: lint + +on: + pull_request: + workflow_dispatch: + push: + paths-ignore: + - "docs/**" + - README.md + - "releases/**" + +permissions: + contents: read + +jobs: + lint: + name: lint + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v4 + - name: Setup go + uses: actions/setup-go@v5 + with: + go-version: "1.21" + cache: false + - name: Go linter + uses: golangci/golangci-lint-action@v3 + with: + version: v1.57 + args: --timeout=30m + install-mode: binary diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml new file mode 100644 index 0000000..88048aa --- /dev/null +++ b/.github/workflows/release.yml @@ -0,0 +1,28 @@ +name: release +on: + push: + tags: + - "v*" +permissions: + contents: write + +jobs: + release: + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v4 + with: + fetch-depth: 0 + - name: Set up Go + uses: actions/setup-go@v5 + with: + go-version: "1.21" + - name: Run GoReleaser + uses: goreleaser/goreleaser-action@v5 + with: + distribution: goreleaser + version: "1.22.0" + args: release --clean + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml new file mode 100644 index 0000000..3c9b74a --- /dev/null +++ b/.github/workflows/test.yml @@ -0,0 +1,45 @@ +name: test + +on: + pull_request: + workflow_dispatch: + push: + paths-ignore: + - "docs/**" + - README.md + - "releases/**" + +jobs: + test: + name: Test + strategy: + matrix: + platform: + - ubuntu-latest + - macos-latest + - windows-latest + runs-on: ${{matrix.platform}} + steps: + - name: Install Go + uses: actions/setup-go@v5 + with: + go-version: "1.21" + - name: Checkout code + uses: actions/checkout@v4 + + - name: Test + run: go test -race -count 1 ./... + + - name: Coverage Test + if: ${{ matrix.platform == 'ubuntu-latest' && github.ref_name == 'main' }} + run: go test -count 1 -coverprofile=coverage.txt ./... + - name: Upload Coverage + if: ${{ matrix.platform == 'ubuntu-latest' && github.ref_name == 'main' }} + uses: codecov/codecov-action@v4.0.1 + with: + token: ${{ secrets.CODECOV_TOKEN }} + slug: grafana/k6exec + + - name: Generate Go Report Card + if: ${{ matrix.platform == 'ubuntu-latest' && github.ref_name == 'main' }} + uses: creekorful/goreportcard-action@v1.0 diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..dcc867e --- /dev/null +++ b/.gitignore @@ -0,0 +1,6 @@ +/k6exec +/k6exec.exe +/build +/node_modules +/package.json +/yarn.lock diff --git a/.golangci.yml b/.golangci.yml new file mode 100644 index 0000000..b8b20f5 --- /dev/null +++ b/.golangci.yml @@ -0,0 +1,133 @@ +# v1.57.2 +# Please don't remove the first line. It uses in CI to determine the golangci version +run: + timeout: 5m + +issues: + # Maximum issues count per one linter. Set to 0 to disable. Default is 50. + max-issues-per-linter: 0 + # Maximum count of issues with the same text. Set to 0 to disable. Default is 3. + max-same-issues: 0 + + # We want to try and improve the comments in the k6 codebase, so individual + # non-golint items from the default exclusion list will gradually be added + # to the exclude-rules below + exclude-use-default: false + + exclude-rules: + # Exclude duplicate code and function length and complexity checking in test + # files (due to common repeats and long functions in test code) + - path: _(test|gen)\.go + linters: + - cyclop + - dupl + - gocognit + - funlen + - lll + - forcetypeassert + - path: js\/modules\/k6\/html\/.*\.go + text: "exported: exported " + linters: + - revive + - path: js\/modules\/k6\/http\/.*_test\.go + linters: + # k6/http module's tests are quite complex because they often have several nested levels. + # The module is in maintainance mode, so we don't intend to port the tests to a parallel version. + - paralleltest + - tparallel + - linters: + - staticcheck # Tracked in https://github.com/grafana/xk6-grpc/issues/14 + text: "The entire proto file grpc/reflection/v1alpha/reflection.proto is marked as deprecated." + - linters: + - forbidigo + text: 'use of `os\.(SyscallError|Signal|Interrupt)` forbidden' + +linters-settings: + exhaustive: + default-signifies-exhaustive: true + cyclop: + max-complexity: 25 + dupl: + threshold: 150 + goconst: + min-len: 10 + min-occurrences: 4 + funlen: + lines: 80 + statements: 60 + forbidigo: + forbid: + - '^(fmt\\.Print(|f|ln)|print|println)$' + # Forbid everything in os, except os.Signal and os.SyscalError + - '^os\.(.*)$(# Using anything except Signal and SyscallError from the os package is forbidden )?' + # Forbid everything in syscall except the uppercase constants + - '^syscall\.[^A-Z_]+$(# Using anything except constants from the syscall package is forbidden )?' + - '^logrus\.Logger$' + +linters: + disable-all: true + enable: + - asasalint + - asciicheck + - bidichk + - bodyclose + - contextcheck + - cyclop + - dogsled + - dupl + - durationcheck + - errcheck + - errchkjson + - errname + - errorlint + - exhaustive + - exportloopref + - forbidigo + - forcetypeassert + - funlen + - gocheckcompilerdirectives + - gochecknoglobals + - gocognit + - goconst + - gocritic + - gofmt + - gofumpt + - goimports + - gomoddirectives + - goprintffuncname + - gosec + - gosimple + - govet + - importas + - ineffassign + - interfacebloat + - lll + - makezero + - misspell + - nakedret + - nestif + - nilerr + - nilnil + - noctx + - nolintlint + - nosprintfhostport + - paralleltest + - prealloc + - predeclared + - promlinter + - revive + - reassign + - rowserrcheck + - sqlclosecheck + - staticcheck + - stylecheck + - tenv + - tparallel + - typecheck + - unconvert + - unparam + - unused + - usestdlibvars + - wastedassign + - whitespace + fast: false diff --git a/.goreleaser.yaml b/.goreleaser.yaml new file mode 100644 index 0000000..a8e709a --- /dev/null +++ b/.goreleaser.yaml @@ -0,0 +1,38 @@ +project_name: k6exec +before: + hooks: + - go mod tidy +dist: build/dist +builds: + - env: + - CGO_ENABLED=0 + goos: ["darwin", "linux", "windows"] + goarch: ["amd64", "arm64"] + ldflags: + - '-s -w -X main.version={{.Version}} -X main.appname={{.ProjectName}}' + dir: cmd/k6exec +source: + enabled: true + name_template: "{{ .ProjectName }}_{{ .Version }}_source" + +archives: + - id: bundle + format: tar.gz + format_overrides: + - goos: windows + format: zip + +checksum: + name_template: "{{ .ProjectName }}_{{ .Version }}_checksums.txt" + +snapshot: + name_template: "{{ incpatch .Version }}-next+{{.ShortCommit}}{{if .IsGitDirty}}.dirty{{else}}{{end}}" + +changelog: + sort: asc + abbrev: -1 + filters: + exclude: + - "^chore:" + - "^docs:" + - "^test:" diff --git a/CODEOWNERS b/CODEOWNERS new file mode 100644 index 0000000..f4cb4f9 --- /dev/null +++ b/CODEOWNERS @@ -0,0 +1 @@ +* @grafana/k6-extensions \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..0ad25db --- /dev/null +++ b/LICENSE @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU Affero General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero General Public License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU Affero General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU Affero General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU Affero General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero General Public License as published + by the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU AGPL, see +. diff --git a/README.md b/README.md new file mode 100644 index 0000000..5bdeda8 --- /dev/null +++ b/README.md @@ -0,0 +1,391 @@ +[![Go Reference](https://pkg.go.dev/badge/github.com/grafana/k6exec.svg)](https://pkg.go.dev/github.com/grafana/k6exec) +[![GitHub Release](https://img.shields.io/github/v/release/grafana/k6exec)](https://github.com/grafana/k6exec/releases/) +[![Go Report Card](https://goreportcard.com/badge/github.com/grafana/k6exec)](https://goreportcard.com/report/github.com/grafana/k6exec) +[![GitHub Actions](https://github.com/grafana/k6exec/actions/workflows/test.yml/badge.svg)](https://github.com/grafana/k6exec/actions/workflows/test.yml) +[![codecov](https://codecov.io/gh/grafana/k6exec/graph/badge.svg?token=6MP3G02V9C)](https://codecov.io/gh/grafana/k6exec) +![GitHub Downloads](https://img.shields.io/github/downloads/grafana/k6exec/total) + +

k6exec

+ +**Launching k6 with extensions** + +The purpose of k6exec is to launch the k6 binary containing the extensions used by the k6 test script. For this purpose, k6exec analyzes the k6 test scripts. + +k6exec is primarily used as a go library for [k6](https://github.com/grafana/k6) and [xk6](https://github.com/grafana/xk6). In addition, it also contains a command-line tool, which is suitable for launching k6 with extensions based on the dependencies of k6 test scripts. + +The command line tool can be integrated into other command line tools as a subcommand. For this purpose, the library also contains the functionality of the command line tool as a factrory function that returns [cobra.Command](https://pkg.go.dev/github.com/spf13/cobra#Command). + +## Install + +Precompiled binaries can be downloaded and installed from the [Releases](https://github.com/grafana/k6exec/releases) page. + +If you have a go development environment, the installation can also be done with the following command: + +``` +go install github.com/grafana/k6exec/cmd/k6exec@latest +``` + +## Usage + + +## k6exec + +**Launching k6 with extensions** + +Launching k6 containing the extensions used by the test script. + + +### Commands + +* [k6exec archive](#k6exec-archive) - Create an archive +* [k6exec cloud](#k6exec-cloud) - Run a test on the cloud +* [k6exec completion](#k6exec-completion) - Generate the autocompletion script for the specified shell +* [k6exec help](#k6exec-help) - Help about any command +* [k6exec inspect](#k6exec-inspect) - Inspect a script or archive +* [k6exec login](#k6exec-login) - Authenticate with a service +* [k6exec new](#k6exec-new) - Create and initialize a new k6 script +* [k6exec pause](#k6exec-pause) - Pause a running test +* [k6exec resume](#k6exec-resume) - Resume a paused test +* [k6exec run](#k6exec-run) - Start a test +* [k6exec scale](#k6exec-scale) - Scale a running test +* [k6exec stats](#k6exec-stats) - Show test metrics +* [k6exec status](#k6exec-status) - Show test status +* [k6exec version](#k6exec-version) - Show application version + +--- +## k6exec archive + +Create an archive + +``` +k6exec archive [flags] +``` + +### Flags + +``` + -h, --help help for archive +``` + +### SEE ALSO + +* [k6exec](#k6exec) - Launching k6 with extensions + +--- +## k6exec cloud + +Run a test on the cloud + +``` +k6exec cloud [flags] +``` + +### Flags + +``` + -h, --help help for cloud +``` + +### SEE ALSO + +* [k6exec](#k6exec) - Launching k6 with extensions + +--- +## k6exec completion + +Generate the autocompletion script for the specified shell + +``` +k6exec completion [flags] +``` + +### Flags + +``` + -h, --help help for completion +``` + +### SEE ALSO + +* [k6exec](#k6exec) - Launching k6 with extensions + +--- +## k6exec help + +Help about any command + +``` +k6exec help [flags] +``` + +### Flags + +``` + -h, --help help for help +``` + +### SEE ALSO + +* [k6exec](#k6exec) - Launching k6 with extensions + +--- +## k6exec inspect + +Inspect a script or archive + +``` +k6exec inspect [flags] +``` + +### Flags + +``` + -h, --help help for inspect +``` + +### SEE ALSO + +* [k6exec](#k6exec) - Launching k6 with extensions + +--- +## k6exec login + +Authenticate with a service + +``` +k6exec login [flags] +``` + +### Flags + +``` + -h, --help help for login +``` + +### SEE ALSO + +* [k6exec](#k6exec) - Launching k6 with extensions + +--- +## k6exec new + +Create and initialize a new k6 script + +``` +k6exec new [flags] +``` + +### Flags + +``` + -h, --help help for new +``` + +### SEE ALSO + +* [k6exec](#k6exec) - Launching k6 with extensions + +--- +## k6exec pause + +Pause a running test + +``` +k6exec pause [flags] +``` + +### Flags + +``` + -h, --help help for pause +``` + +### SEE ALSO + +* [k6exec](#k6exec) - Launching k6 with extensions + +--- +## k6exec resume + +Resume a paused test + +``` +k6exec resume [flags] +``` + +### Flags + +``` + -h, --help help for resume +``` + +### SEE ALSO + +* [k6exec](#k6exec) - Launching k6 with extensions + +--- +## k6exec run + +Start a test + +``` +k6exec run [flags] +``` + +### Flags + +``` + -h, --help help for run +``` + +### SEE ALSO + +* [k6exec](#k6exec) - Launching k6 with extensions + +--- +## k6exec scale + +Scale a running test + +``` +k6exec scale [flags] +``` + +### Flags + +``` + -h, --help help for scale +``` + +### SEE ALSO + +* [k6exec](#k6exec) - Launching k6 with extensions + +--- +## k6exec stats + +Show test metrics + +``` +k6exec stats [flags] +``` + +### Flags + +``` + -h, --help help for stats +``` + +### SEE ALSO + +* [k6exec](#k6exec) - Launching k6 with extensions + +--- +## k6exec status + +Show test status + +``` +k6exec status [flags] +``` + +### Flags + +``` + -h, --help help for status +``` + +### SEE ALSO + +* [k6exec](#k6exec) - Launching k6 with extensions + +--- +## k6exec version + +Show application version + +``` +k6exec version [flags] +``` + +### Flags + +``` + -h, --help help for version +``` + +### SEE ALSO + +* [k6exec](#k6exec) - Launching k6 with extensions + + + +## Development + +### Tasks + +This section contains a description of the tasks performed during development. If you have the [xc (Markdown defined task runner)](https://github.com/joerdav/xc) command-line tool, individual tasks can be executed simply by using the `xc task-name` command. + +
Click to expand + +#### readme + +Update documentation in README.md. + +``` +go run ./tools/gendoc README.md +``` + +#### lint + +Run the static analyzer. + +``` +golangci-lint run +``` + +#### test + +Run the tests. + +``` +go test -count 1 -race -coverprofile=build/coverage.txt ./... +``` + +#### coverage + +View the test coverage report. + +``` +go tool cover -html=build/coverage.txt +``` + +#### build + +Build the executable binary. + +This is the easiest way to create an executable binary (although the release process uses the goreleaser tool to create release versions). + +``` +go build -ldflags="-w -s" -o build/k6exec ./cmd/k6exec +``` + +#### snapshot + +Creating an executable binary with a snapshot version. + +The goreleaser command-line tool is used during the release process. During development, it is advisable to create binaries with the same tool from time to time. + +``` +goreleaser build --snapshot --clean --single-target -o build/k6exec +``` + +#### clean + +Delete the build directory. + +``` +rm -rf build +``` + +
diff --git a/bin_unix.go b/bin_unix.go new file mode 100644 index 0000000..3443d33 --- /dev/null +++ b/bin_unix.go @@ -0,0 +1,8 @@ +//go:build !windows + +package k6exec + +const ( + k6binary = "k6" + k6temp = "k6-*" +) diff --git a/bin_windows.go b/bin_windows.go new file mode 100644 index 0000000..603ca4c --- /dev/null +++ b/bin_windows.go @@ -0,0 +1,8 @@ +//go:build windows + +package k6exec + +const ( + k6binary = "k6.exe" + k6temp = "k6-*.exe" +) diff --git a/build.go b/build.go new file mode 100644 index 0000000..f09f4e3 --- /dev/null +++ b/build.go @@ -0,0 +1,90 @@ +package k6exec + +import ( + "context" + "errors" + "fmt" + "io" + "net/http" + "net/url" + "os" + "os/exec" + "path/filepath" + "syscall" + + "github.com/grafana/k6deps" +) + +func build(_ []*k6deps.Dependency) (*url.URL, error) { + loc, err := exec.LookPath(k6binary) + if err != nil { + return nil, err + } + + return url.Parse("file://" + filepath.ToSlash(loc)) +} + +func download(ctx context.Context, from *url.URL, dir string, client *http.Client) error { + dest, err := os.CreateTemp(dir, k6temp) //nolint:forbidigo + if err != nil { + return err + } + + if from.Scheme == "file" { + err = fileDownload(from, dest) + } else { + err = httpDownload(ctx, from, dest, client) + } + + if err != nil { + _ = os.Remove(dest.Name()) //nolint:forbidigo + + return err + } + + if err = dest.Close(); err != nil { + return err + } + + return os.Rename(dest.Name(), filepath.Join(dir, k6binary)) //nolint:forbidigo +} + +func fileDownload(from *url.URL, dest *os.File) error { //nolint:forbidigo + src, err := os.Open(from.Path) //nolint:forbidigo + if err != nil { + return err + } + + defer src.Close() //nolint:errcheck + + _, err = io.Copy(dest, src) + if err != nil { + return err + } + + return os.Chmod(dest.Name(), syscall.S_IRUSR|syscall.S_IXUSR) //nolint:forbidigo +} + +func httpDownload(ctx context.Context, from *url.URL, dest *os.File, client *http.Client) error { //nolint:forbidigo + req, err := http.NewRequestWithContext(ctx, http.MethodGet, from.String(), nil) + if err != nil { + return err + } + + resp, err := client.Do(req) + if err != nil { + return fmt.Errorf("%w: %s", errDownload, err.Error()) + } + + if resp.StatusCode != http.StatusOK { + return fmt.Errorf("%w: %s", errDownload, resp.Status) + } + + defer resp.Body.Close() //nolint:errcheck + + _, err = io.Copy(dest, resp.Body) + + return err +} + +var errDownload = errors.New("download error") diff --git a/cmd/cmd.go b/cmd/cmd.go new file mode 100644 index 0000000..1fb1aeb --- /dev/null +++ b/cmd/cmd.go @@ -0,0 +1,124 @@ +// Package cmd contains run cobra command factory function. +package cmd + +import ( + "context" + _ "embed" + "os" + + "github.com/grafana/k6deps" + "github.com/grafana/k6exec" + "github.com/spf13/cobra" +) + +//go:embed help.md +var help string + +// New creates new cobra command for exec command. +func New() *cobra.Command { + root := &cobra.Command{ + Use: "exec", + Short: "Launching k6 with extensions", + Long: help, + SilenceUsage: true, + SilenceErrors: true, + DisableAutoGenTag: true, + CompletionOptions: cobra.CompletionOptions{DisableDefaultCmd: true}, + } + root.SetHelpCommand(&cobra.Command{Hidden: true}) + + for _, cmd := range subcommands() { + cmd := cmd + cmd.RunE = exec + cmd.SilenceErrors = true + cmd.SilenceUsage = true + cmd.FParseErrWhitelist = cobra.FParseErrWhitelist{UnknownFlags: true} + cmd.SetHelpFunc(usage) + + root.AddCommand(&cmd) + } + + return root +} + +func usage(cmd *cobra.Command, args []string) { + err := exec(cmd, append(args, "-h")) + if err != nil { + cmd.PrintErr(err) + } +} + +func exec(sub *cobra.Command, args []string) error { + var ( + deps k6deps.Dependencies + err error + ) + + if scriptname, hasScript := scriptArg(sub, args); hasScript { + deps, err = k6deps.Analyze(&k6deps.Options{ + Script: k6deps.Source{ + Name: scriptname, + }, + }) + if err != nil { + return err + } + } + + args = append([]string{sub.Name()}, args...) + + cmd, err := k6exec.Command(context.TODO(), args, deps, nil) + if err != nil { + return err + } + + cmd.Stderr = os.Stderr //nolint:forbidigo + cmd.Stdout = os.Stdout //nolint:forbidigo + cmd.Stdin = os.Stdin //nolint:forbidigo + + return cmd.Run() +} + +func scriptArg(cmd *cobra.Command, args []string) (string, bool) { + if len(cmd.Annotations) == 0 { + return "", false + } + + if _, use := cmd.Annotations[useExtensions]; !use { + return "", false + } + + if len(args) == 0 { + return "", false + } + + last := args[len(args)-1] + if len(last) == 0 || last[0] == '-' { + return "", false + } + + return last, true +} + +func subcommands() []cobra.Command { + annext := map[string]string{useExtensions: "true"} + + return []cobra.Command{ + {Use: "help", Short: "Help about any command"}, + {Use: "resume", Short: "Resume a paused test"}, + {Use: "scale", Short: "Scale a running test"}, + {Use: "cloud", Short: "Run a test on the cloud"}, + {Use: "completion", Short: "Generate the autocompletion script for the specified shell"}, + {Use: "inspect", Short: "Inspect a script or archive"}, + {Use: "pause", Short: "Pause a running test"}, + {Use: "status", Short: "Show test status"}, + {Use: "login", Short: "Authenticate with a service"}, + {Use: "stats", Short: "Show test metrics"}, + {Use: "version", Short: "Show application version"}, + {Use: "new", Short: "Create and initialize a new k6 script"}, + {Use: "run", Short: "Start a test", Annotations: annext}, + {Use: "archive", Short: "Create an archive", Annotations: annext}, + } +} + +const useExtensions = "useExtensions" diff --git a/cmd/help.md b/cmd/help.md new file mode 100644 index 0000000..b9469fb --- /dev/null +++ b/cmd/help.md @@ -0,0 +1 @@ +Launching k6 containing the extensions used by the test script. diff --git a/cmd/k6exec/error.go b/cmd/k6exec/error.go new file mode 100644 index 0000000..9a4244b --- /dev/null +++ b/cmd/k6exec/error.go @@ -0,0 +1,49 @@ +package main + +import ( + "errors" + "os" + "strings" + + "github.com/evanw/esbuild/pkg/api" + "golang.org/x/term" +) + +type formatableError = interface { + error + Format(width int, color bool) string +} + +func formatError(err error) string { + width, color := formatOptions(int(os.Stderr.Fd())) //nolint:forbidigo + + var perr formatableError + if errors.As(err, &perr) { + return perr.Format(width, color) + } + + return strings.Join( + api.FormatMessages( + []api.Message{{Text: err.Error()}}, + api.FormatMessagesOptions{TerminalWidth: width, Color: color}, + ), + "\n", + ) +} + +func formatOptions(fd int) (int, bool) { + color := false + width := 0 + + if term.IsTerminal(fd) { + if os.Getenv("NO_COLOR") != "true" { //nolint:forbidigo + color = true + } + + if w, _, err := term.GetSize(fd); err == nil { + width = w + } + } + + return width, color +} diff --git a/cmd/k6exec/main.go b/cmd/k6exec/main.go new file mode 100644 index 0000000..8eb7f3e --- /dev/null +++ b/cmd/k6exec/main.go @@ -0,0 +1,39 @@ +// Package main contains the main function for k6exec CLI tool. +package main + +import ( + "log" + "os" + "strings" + + "github.com/grafana/k6exec/cmd" + "github.com/spf13/cobra" +) + +//nolint:gochecknoglobals +var ( + appname = "k6exec" + version = "dev" +) + +func main() { + runCmd(newCmd(os.Args[1:])) //nolint:forbidigo +} + +func newCmd(args []string) *cobra.Command { + cmd := cmd.New() + cmd.Use = strings.Replace(cmd.Use, cmd.Name(), appname, 1) + cmd.Version = version + cmd.SetArgs(args) + + return cmd +} + +func runCmd(cmd *cobra.Command) { + log.SetFlags(0) + log.Writer() + + if err := cmd.Execute(); err != nil { + log.Fatal(formatError(err)) + } +} diff --git a/command.go b/command.go new file mode 100644 index 0000000..88f2933 --- /dev/null +++ b/command.go @@ -0,0 +1,40 @@ +package k6exec + +import ( + "context" + "os/exec" + "path/filepath" + + "github.com/adrg/xdg" + "github.com/grafana/k6deps" +) + +// Command returns the exec.Cmd struct to execute k6 with the given dependencies and arguments. +func Command(ctx context.Context, args []string, deps k6deps.Dependencies, opts *Options) (*exec.Cmd, error) { + cachedir, err := xdg.CacheFile(opts.appname()) + if err != nil { + return nil, err + } + + exe := filepath.Join(cachedir, k6binary) + + mods, err := unmarshalVersionOutput(ctx, exe) + if err != nil { + return nil, err + } + + if !mods.fulfill(deps) { + demands := mods.merge(deps) + + loc, err := build(demands.Sorted()) + if err != nil { + return nil, err + } + + if err = download(ctx, loc, cachedir, opts.client()); err != nil { + return nil, err + } + } + + return exec.Command(exe, args...), nil //nolint:gosec +} diff --git a/doc.go b/doc.go new file mode 100644 index 0000000..f32223c --- /dev/null +++ b/doc.go @@ -0,0 +1,2 @@ +// Package k6exec contains a k6 launcher with extensions. +package k6exec diff --git a/examples/device.js b/examples/device.js new file mode 100644 index 0000000..73df588 --- /dev/null +++ b/examples/device.js @@ -0,0 +1,14 @@ +import { parse } from "k6/x/yaml"; + +const source = ` +- name: foo +- name: bar +`; + +const devices = parse(source); + +function getDevice() { + return devices[0]; +} + +module.exports = { getDevice }; diff --git a/examples/script.js b/examples/script.js new file mode 100644 index 0000000..fbe4595 --- /dev/null +++ b/examples/script.js @@ -0,0 +1,11 @@ +"use k6 >= 0.49"; +"use k6 with k6/x/faker >= 0.2.0"; + +import { newUser } from "./user.js"; +import { getDevice } from "./device.js"; + +export default () => { + const user = newUser("John"); + console.log(user); + console.log(getDevice()); +}; diff --git a/examples/user.js b/examples/user.js new file mode 100644 index 0000000..7f48a41 --- /dev/null +++ b/examples/user.js @@ -0,0 +1,14 @@ +import "k6/x/faker"; + +class UserAccount { + constructor(name) { + this.name = name; + this.id = Math.floor(Math.random() * Number.MAX_SAFE_INTEGER); + } +} + +function newUser(name) { + return new UserAccount(name); +} + +export { newUser }; diff --git a/go.mod b/go.mod new file mode 100644 index 0000000..6cf954d --- /dev/null +++ b/go.mod @@ -0,0 +1,20 @@ +module github.com/grafana/k6exec + +go 1.21 + +require ( + github.com/adrg/xdg v0.4.0 + github.com/evanw/esbuild v0.21.5 + github.com/grafana/clireadme v0.1.0 + github.com/grafana/k6deps v0.1.1 + github.com/spf13/cobra v1.8.0 + golang.org/x/term v0.21.0 +) + +require ( + github.com/Masterminds/semver/v3 v3.2.1 // indirect + github.com/grafana/k6pack v0.2.0 // indirect + github.com/inconshreveable/mousetrap v1.1.0 // indirect + github.com/spf13/pflag v1.0.5 // indirect + golang.org/x/sys v0.21.0 // indirect +) diff --git a/go.sum b/go.sum new file mode 100644 index 0000000..fb45157 --- /dev/null +++ b/go.sum @@ -0,0 +1,39 @@ +github.com/Masterminds/semver/v3 v3.2.1 h1:RN9w6+7QoMeJVGyfmbcgs28Br8cvmnucEXnY0rYXWg0= +github.com/Masterminds/semver/v3 v3.2.1/go.mod h1:qvl/7zhW3nngYb5+80sSMF+FG2BjYrf8m9wsX0PNOMQ= +github.com/adrg/xdg v0.4.0 h1:RzRqFcjH4nE5C6oTAxhBtoE2IRyjBSa62SCbyPidvls= +github.com/adrg/xdg v0.4.0/go.mod h1:N6ag73EX4wyxeaoeHctc1mas01KZgsj5tYiAIwqJE/E= +github.com/cpuguy83/go-md2man/v2 v2.0.3/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46tRHOmNcaadrF8o= +github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= +github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/evanw/esbuild v0.21.5 h1:oShm8TT5QUhf6vM7teg0nmd14eHu64dPmVluC2f4DMg= +github.com/evanw/esbuild v0.21.5/go.mod h1:D2vIQZqV/vIf/VRHtViaUtViZmG7o+kKmlBfVQuRi48= +github.com/grafana/clireadme v0.1.0 h1:KYEYSnYdSzmHf3bufaK6fQZ5j4dzvM/T+G6Ba+qNnAM= +github.com/grafana/clireadme v0.1.0/go.mod h1:Wy4KIG2ZBGMYAYyF9l7qAy+yoJVasqk/txsRgoRI3gc= +github.com/grafana/k6deps v0.1.1 h1:ei24xajAvBagLVu0O7UaSz0tJ1GhHxqnmJ+inCfQ7Z8= +github.com/grafana/k6deps v0.1.1/go.mod h1:j8UOs5mZhn5+hpJqDtl5zjYRjMpBKYf+FwaBmHHcfao= +github.com/grafana/k6pack v0.2.0 h1:Y8udypzuzFdcFMRHnP5VkdjYXWLb/ouKzm4ct3OqPmg= +github.com/grafana/k6pack v0.2.0/go.mod h1:cltO5vmQOObJDtKbRkNVGymk3J+MRhriJyQg1JJzeEc= +github.com/inconshreveable/mousetrap v1.1.0 h1:wN+x4NVGpMsO7ErUn/mUI3vEoE6Jt13X2s0bqwp9tc8= +github.com/inconshreveable/mousetrap v1.1.0/go.mod h1:vpF70FUmC8bwa3OWnCshd2FqLfsEA9PFc4w1p2J65bw= +github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= +github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM= +github.com/spf13/cobra v1.8.0 h1:7aJaZx1B85qltLMc546zn58BxxfZdR/W22ej9CFoEf0= +github.com/spf13/cobra v1.8.0/go.mod h1:WXLWApfZ71AjXPya3WOlMsY9yMs7YeiHhFVlvLyhcho= +github.com/spf13/pflag v1.0.5 h1:iy+VFUOCP1a+8yFto/drg2CJ5u0yRoB7fZw3DKv/JXA= +github.com/spf13/pflag v1.0.5/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An2Bg= +github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= +github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= +github.com/stretchr/testify v1.9.0 h1:HtqpIVDClZ4nwg75+f6Lvsy/wHu+3BoSGCbBAcpTsTg= +github.com/stretchr/testify v1.9.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY= +golang.org/x/sys v0.0.0-20211025201205-69cdffdb9359/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.21.0 h1:rF+pYz3DAGSQAxAu1CbC7catZg4ebC4UIeIhKxBZvws= +golang.org/x/sys v0.21.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA= +golang.org/x/term v0.21.0 h1:WVXCp+/EBEHOj53Rvu+7KiT/iElMrO8ACK16SMZ3jaA= +golang.org/x/term v0.21.0/go.mod h1:ooXLefLobQVslOqselCNF4SxFAaoS6KujMbsGzSDmX0= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= +gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= +gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= diff --git a/module.go b/module.go new file mode 100644 index 0000000..2c474a3 --- /dev/null +++ b/module.go @@ -0,0 +1,105 @@ +package k6exec + +import ( + "context" + "os/exec" + "regexp" + + "github.com/Masterminds/semver/v3" + "github.com/grafana/k6deps" +) + +type module struct { + name string + version *semver.Version +} + +type modules map[string]*module + +func (mods *modules) unmarshalVersionOutput(text []byte) error { + *mods = make(modules) + + if allmatch := reK6.FindAllSubmatch(text, -1); allmatch != nil { + match := allmatch[0] + + version, err := semver.NewVersion(string(match[idxK6Version])) + if err != nil { + return err + } + + (*mods)[k6module] = &module{name: k6module, version: version} + } + + for _, match := range reExtension.FindAllSubmatch(text, -1) { + version, err := semver.NewVersion(string(match[idxExtVersion])) + if err != nil { + return err + } + + name := string(match[idxExtName]) + + (*mods)[name] = &module{name: name, version: version} + } + + return nil +} + +func (mods modules) fulfill(deps k6deps.Dependencies) bool { + for _, dep := range deps { + mod, found := mods[dep.Name] + if !found || (dep.Constraints != nil && !dep.Constraints.Check(mod.version)) { + return false + } + } + + return true +} + +func (mods modules) merge(deps k6deps.Dependencies) k6deps.Dependencies { + merged := make(k6deps.Dependencies, len(deps)) + + for name, dep := range deps { + merged[name] = dep + } + + for name := range mods { + if _, found := merged[name]; !found { + merged[name] = &k6deps.Dependency{Name: name} + } + } + + if _, found := merged[k6module]; !found { + merged[k6module] = &k6deps.Dependency{Name: k6module} + } + + return merged +} + +func unmarshalVersionOutput(ctx context.Context, cmd string) (modules, error) { + c := exec.CommandContext(ctx, cmd, "version") + + out, err := c.CombinedOutput() + if err != nil { + return nil, err + } + + var mods modules + + err = mods.unmarshalVersionOutput(out) + if err != nil { + return nil, err + } + + return mods, nil +} + +//nolint:gochecknoglobals +var ( + reK6 = regexp.MustCompile(`k6 (?P[^ ]+) .*`) + reExtension = regexp.MustCompile(` (?P[^ ]+) (?P[^,]+), (?P[^ ]+) \[([^\]]+)\]`) + idxK6Version = reK6.SubexpIndex("k6Version") + idxExtVersion = reExtension.SubexpIndex("extVersion") + idxExtName = reExtension.SubexpIndex("extName") +) + +const k6module = "k6" diff --git a/options.go b/options.go new file mode 100644 index 0000000..d84a5df --- /dev/null +++ b/options.go @@ -0,0 +1,39 @@ +package k6exec + +import ( + "net/http" + "os" + "path/filepath" +) + +// Options contains the optional parameters of the Command function. +type Options struct { + // AppName contains the name of the application. It is used to define the default value of CacheDir. + // If empty, it defaults to os.Args[0]. + AppName string + // CacheDir specifies the name of the directory where the k6 binary can be cached. + // Its default is determined based on the XDG Base Directory Specification. + // https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html + CacheDir string + // NoCache can be used to disable the k6 binary cache. + NoCache bool + // Client is used during HTTP communication with the build service. + // If absent, http.DefaultClient will be used. + Client *http.Client +} + +func (o *Options) appname() string { + if o != nil && len(o.AppName) > 0 { + return o.AppName + } + + return filepath.Base(os.Args[0]) //nolint:forbidigo +} + +func (o *Options) client() *http.Client { + if o != nil && o.Client != nil { + return o.Client + } + + return http.DefaultClient +} diff --git a/tools/gendoc/main.go b/tools/gendoc/main.go new file mode 100644 index 0000000..15e2fe5 --- /dev/null +++ b/tools/gendoc/main.go @@ -0,0 +1,16 @@ +// Package main contains CLI documentation generator tool. +package main + +import ( + _ "embed" + "strings" + + "github.com/grafana/clireadme" + "github.com/grafana/k6exec/cmd" +) + +func main() { + root := cmd.New() + root.Use = strings.ReplaceAll(root.Use, "exec", "k6exec") + clireadme.Main(root, 1) +}