chore(app): establish capture contracts and offline Go tooling
- commit
- 3cdbdaa2383ccba35b57a760b5f4c2f4d33ae649
- author
- brice · · 2026-09-30 08:01 UTC
- committer
- brice · · 2026-09-30 14:48 UTC
- parent
- cf3176c
- signature
- GPG Verified
CD88F9E564E0102646FB6077A1A07C7C7C3E349D· arch-gpg Verified for the committer email
14 files · +1807 -0
M .gitignore +1 -0
| @@ -6,3 +6,4 @@ | |||
| 6 | 6 | coverage/ | |
| 7 | 7 | go.work | |
| 8 | 8 | go.work.sum | |
| 9 | + | /.local-deps/ | |
| @@ -6,3 +6,4 @@ | |||||
| 6 | coverage/ | 6 | coverage/ | ||
| 7 | go.work | 7 | go.work | ||
| 8 | go.work.sum | 8 | go.work.sum | ||
| 9 | + | /.local-deps/ | |||
A .hexcheck.yaml +21 -0
| @@ -0,0 +1,21 @@ | |||
| 1 | + | version: 1 | |
| 2 | + | components: | |
| 3 | + | core: { role: core, paths: [internal/core/**] } | |
| 4 | + | ports: { role: ports, paths: [internal/ports/**] } | |
| 5 | + | adapters: { role: adapter, paths: [internal/adapters/**, internal/logging/**] } | |
| 6 | + | # app is the composition root: it wires adapters to core, like cmd. | |
| 7 | + | entrypoints: { role: entrypoint, paths: [cmd/**, internal/app/**] } | |
| 8 | + | generated: { role: ignore, paths: [internal/mocks/**] } | |
| 9 | + | rules: | |
| 10 | + | no-adapter-imports-in-core: error | |
| 11 | + | no-infra-imports-in-usecase: error | |
| 12 | + | no-framework-types-in-core: error | |
| 13 | + | no-infra-types-in-ports: error | |
| 14 | + | missing-generated-mock-for-port: error | |
| 15 | + | mocking: | |
| 16 | + | generatedMockPaths: [internal/mocks/**] | |
| 17 | + | generatedMockNamePatterns: ['Mock{{Interface}}', '{{Interface}}Mock'] | |
| 18 | + | ruleSettings: | |
| 19 | + | suspicious-business-logic-in-adapter: | |
| 20 | + | # app is the composition root; starting core and wiring channels is its job. | |
| 21 | + | excludePaths: [internal/app/app.go] | |
| @@ -0,0 +1,21 @@ | |||||
| 1 | + | version: 1 | |||
| 2 | + | components: | |||
| 3 | + | core: { role: core, paths: [internal/core/**] } | |||
| 4 | + | ports: { role: ports, paths: [internal/ports/**] } | |||
| 5 | + | adapters: { role: adapter, paths: [internal/adapters/**, internal/logging/**] } | |||
| 6 | + | # app is the composition root: it wires adapters to core, like cmd. | |||
| 7 | + | entrypoints: { role: entrypoint, paths: [cmd/**, internal/app/**] } | |||
| 8 | + | generated: { role: ignore, paths: [internal/mocks/**] } | |||
| 9 | + | rules: | |||
| 10 | + | no-adapter-imports-in-core: error | |||
| 11 | + | no-infra-imports-in-usecase: error | |||
| 12 | + | no-framework-types-in-core: error | |||
| 13 | + | no-infra-types-in-ports: error | |||
| 14 | + | missing-generated-mock-for-port: error | |||
| 15 | + | mocking: | |||
| 16 | + | generatedMockPaths: [internal/mocks/**] | |||
| 17 | + | generatedMockNamePatterns: ['Mock{{Interface}}', '{{Interface}}Mock'] | |||
| 18 | + | ruleSettings: | |||
| 19 | + | suspicious-business-logic-in-adapter: | |||
| 20 | + | # app is the composition root; starting core and wiring channels is its job. | |||
| 21 | + | excludePaths: [internal/app/app.go] | |||
A .mockery.yml +21 -0
| @@ -0,0 +1,21 @@ | |||
| 1 | + | # Mockery v3, testify template. The interface owner fills in `packages`: | |
| 2 | + | # cross-layer interfaces: internal/ports -> internal/mocks/ports (package portsmocks) | |
| 3 | + | # adapter-private seams: next to the code as *_mock_test.go | |
| 4 | + | all: false | |
| 5 | + | formatter: goimports | |
| 6 | + | force-file-write: true | |
| 7 | + | structname: '{{.Mock}}{{.InterfaceName}}' | |
| 8 | + | template: testify | |
| 9 | + | template-schema: '{{.Template}}.schema.json' | |
| 10 | + | require-template-schema-exists: true | |
| 11 | + | packages: | |
| 12 | + | github.com/bnema/nefercap/internal/ports: | |
| 13 | + | config: | |
| 14 | + | dir: internal/mocks/ports | |
| 15 | + | pkgname: portsmocks | |
| 16 | + | filename: '{{.InterfaceFile | base | trimSuffix ".go"}}_mock.go' | |
| 17 | + | interfaces: | |
| 18 | + | Source: | |
| 19 | + | ScreenshotWriter: | |
| 20 | + | VideoWriter: | |
| 21 | + | Selector: | |
| @@ -0,0 +1,21 @@ | |||||
| 1 | + | # Mockery v3, testify template. The interface owner fills in `packages`: | |||
| 2 | + | # cross-layer interfaces: internal/ports -> internal/mocks/ports (package portsmocks) | |||
| 3 | + | # adapter-private seams: next to the code as *_mock_test.go | |||
| 4 | + | all: false | |||
| 5 | + | formatter: goimports | |||
| 6 | + | force-file-write: true | |||
| 7 | + | structname: '{{.Mock}}{{.InterfaceName}}' | |||
| 8 | + | template: testify | |||
| 9 | + | template-schema: '{{.Template}}.schema.json' | |||
| 10 | + | require-template-schema-exists: true | |||
| 11 | + | packages: | |||
| 12 | + | github.com/bnema/nefercap/internal/ports: | |||
| 13 | + | config: | |||
| 14 | + | dir: internal/mocks/ports | |||
| 15 | + | pkgname: portsmocks | |||
| 16 | + | filename: '{{.InterfaceFile | base | trimSuffix ".go"}}_mock.go' | |||
| 17 | + | interfaces: | |||
| 18 | + | Source: | |||
| 19 | + | ScreenshotWriter: | |||
| 20 | + | VideoWriter: | |||
| 21 | + | Selector: | |||
A LICENSE +674 -0
| @@ -0,0 +1,674 @@ | |||
| 1 | + | GNU GENERAL PUBLIC LICENSE | |
| 2 | + | Version 3, 29 June 2007 | |
| 3 | + | ||
| 4 | + | Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/> | |
| 5 | + | Everyone is permitted to copy and distribute verbatim copies | |
| 6 | + | of this license document, but changing it is not allowed. | |
| 7 | + | ||
| 8 | + | Preamble | |
| 9 | + | ||
| 10 | + | The GNU General Public License is a free, copyleft license for | |
| 11 | + | software and other kinds of works. | |
| 12 | + | ||
| 13 | + | The licenses for most software and other practical works are designed | |
| 14 | + | to take away your freedom to share and change the works. By contrast, | |
| 15 | + | the GNU General Public License is intended to guarantee your freedom to | |
| 16 | + | share and change all versions of a program--to make sure it remains free | |
| 17 | + | software for all its users. We, the Free Software Foundation, use the | |
| 18 | + | GNU General Public License for most of our software; it applies also to | |
| 19 | + | any other work released this way by its authors. You can apply it to | |
| 20 | + | your programs, too. | |
| 21 | + | ||
| 22 | + | When we speak of free software, we are referring to freedom, not | |
| 23 | + | price. Our General Public Licenses are designed to make sure that you | |
| 24 | + | have the freedom to distribute copies of free software (and charge for | |
| 25 | + | them if you wish), that you receive source code or can get it if you | |
| 26 | + | want it, that you can change the software or use pieces of it in new | |
| 27 | + | free programs, and that you know you can do these things. | |
| 28 | + | ||
| 29 | + | To protect your rights, we need to prevent others from denying you | |
| 30 | + | these rights or asking you to surrender the rights. Therefore, you have | |
| 31 | + | certain responsibilities if you distribute copies of the software, or if | |
| 32 | + | you modify it: responsibilities to respect the freedom of others. | |
| 33 | + | ||
| 34 | + | For example, if you distribute copies of such a program, whether | |
| 35 | + | gratis or for a fee, you must pass on to the recipients the same | |
| 36 | + | freedoms that you received. You must make sure that they, too, receive | |
| 37 | + | or can get the source code. And you must show them these terms so they | |
| 38 | + | know their rights. | |
| 39 | + | ||
| 40 | + | Developers that use the GNU GPL protect your rights with two steps: | |
| 41 | + | (1) assert copyright on the software, and (2) offer you this License | |
| 42 | + | giving you legal permission to copy, distribute and/or modify it. | |
| 43 | + | ||
| 44 | + | For the developers' and authors' protection, the GPL clearly explains | |
| 45 | + | that there is no warranty for this free software. For both users' and | |
| 46 | + | authors' sake, the GPL requires that modified versions be marked as | |
| 47 | + | changed, so that their problems will not be attributed erroneously to | |
| 48 | + | authors of previous versions. | |
| 49 | + | ||
| 50 | + | Some devices are designed to deny users access to install or run | |
| 51 | + | modified versions of the software inside them, although the manufacturer | |
| 52 | + | can do so. This is fundamentally incompatible with the aim of | |
| 53 | + | protecting users' freedom to change the software. The systematic | |
| 54 | + | pattern of such abuse occurs in the area of products for individuals to | |
| 55 | + | use, which is precisely where it is most unacceptable. Therefore, we | |
| 56 | + | have designed this version of the GPL to prohibit the practice for those | |
| 57 | + | products. If such problems arise substantially in other domains, we | |
| 58 | + | stand ready to extend this provision to those domains in future versions | |
| 59 | + | of the GPL, as needed to protect the freedom of users. | |
| 60 | + | ||
| 61 | + | Finally, every program is threatened constantly by software patents. | |
| 62 | + | States should not allow patents to restrict development and use of | |
| 63 | + | software on general-purpose computers, but in those that do, we wish to | |
| 64 | + | avoid the special danger that patents applied to a free program could | |
| 65 | + | make it effectively proprietary. To prevent this, the GPL assures that | |
| 66 | + | patents cannot be used to render the program non-free. | |
| 67 | + | ||
| 68 | + | The precise terms and conditions for copying, distribution and | |
| 69 | + | modification follow. | |
| 70 | + | ||
| 71 | + | TERMS AND CONDITIONS | |
| 72 | + | ||
| 73 | + | 0. Definitions. | |
| 74 | + | ||
| 75 | + | "This License" refers to version 3 of the GNU General Public License. | |
| 76 | + | ||
| 77 | + | "Copyright" also means copyright-like laws that apply to other kinds of | |
| 78 | + | works, such as semiconductor masks. | |
| 79 | + | ||
| 80 | + | "The Program" refers to any copyrightable work licensed under this | |
| 81 | + | License. Each licensee is addressed as "you". "Licensees" and | |
| 82 | + | "recipients" may be individuals or organizations. | |
| 83 | + | ||
| 84 | + | To "modify" a work means to copy from or adapt all or part of the work | |
| 85 | + | in a fashion requiring copyright permission, other than the making of an | |
| 86 | + | exact copy. The resulting work is called a "modified version" of the | |
| 87 | + | earlier work or a work "based on" the earlier work. | |
| 88 | + | ||
| 89 | + | A "covered work" means either the unmodified Program or a work based | |
| 90 | + | on the Program. | |
| 91 | + | ||
| 92 | + | To "propagate" a work means to do anything with it that, without | |
| 93 | + | permission, would make you directly or secondarily liable for | |
| 94 | + | infringement under applicable copyright law, except executing it on a | |
| 95 | + | computer or modifying a private copy. Propagation includes copying, | |
| 96 | + | distribution (with or without modification), making available to the | |
| 97 | + | public, and in some countries other activities as well. | |
| 98 | + | ||
| 99 | + | To "convey" a work means any kind of propagation that enables other | |
| 100 | + | parties to make or receive copies. Mere interaction with a user through | |
| 101 | + | a computer network, with no transfer of a copy, is not conveying. | |
| 102 | + | ||
| 103 | + | An interactive user interface displays "Appropriate Legal Notices" | |
| 104 | + | to the extent that it includes a convenient and prominently visible | |
| 105 | + | feature that (1) displays an appropriate copyright notice, and (2) | |
| 106 | + | tells the user that there is no warranty for the work (except to the | |
| 107 | + | extent that warranties are provided), that licensees may convey the | |
| 108 | + | work under this License, and how to view a copy of this License. If | |
| 109 | + | the interface presents a list of user commands or options, such as a | |
| 110 | + | menu, a prominent item in the list meets this criterion. | |
| 111 | + | ||
| 112 | + | 1. Source Code. | |
| 113 | + | ||
| 114 | + | The "source code" for a work means the preferred form of the work | |
| 115 | + | for making modifications to it. "Object code" means any non-source | |
| 116 | + | form of a work. | |
| 117 | + | ||
| 118 | + | A "Standard Interface" means an interface that either is an official | |
| 119 | + | standard defined by a recognized standards body, or, in the case of | |
| 120 | + | interfaces specified for a particular programming language, one that | |
| 121 | + | is widely used among developers working in that language. | |
| 122 | + | ||
| 123 | + | The "System Libraries" of an executable work include anything, other | |
| 124 | + | than the work as a whole, that (a) is included in the normal form of | |
| 125 | + | packaging a Major Component, but which is not part of that Major | |
| 126 | + | Component, and (b) serves only to enable use of the work with that | |
| 127 | + | Major Component, or to implement a Standard Interface for which an | |
| 128 | + | implementation is available to the public in source code form. A | |
| 129 | + | "Major Component", in this context, means a major essential component | |
| 130 | + | (kernel, window system, and so on) of the specific operating system | |
| 131 | + | (if any) on which the executable work runs, or a compiler used to | |
| 132 | + | produce the work, or an object code interpreter used to run it. | |
| 133 | + | ||
| 134 | + | The "Corresponding Source" for a work in object code form means all | |
| 135 | + | the source code needed to generate, install, and (for an executable | |
| 136 | + | work) run the object code and to modify the work, including scripts to | |
| 137 | + | control those activities. However, it does not include the work's | |
| 138 | + | System Libraries, or general-purpose tools or generally available free | |
| 139 | + | programs which are used unmodified in performing those activities but | |
| 140 | + | which are not part of the work. For example, Corresponding Source | |
| 141 | + | includes interface definition files associated with source files for | |
| 142 | + | the work, and the source code for shared libraries and dynamically | |
| 143 | + | linked subprograms that the work is specifically designed to require, | |
| 144 | + | such as by intimate data communication or control flow between those | |
| 145 | + | subprograms and other parts of the work. | |
| 146 | + | ||
| 147 | + | The Corresponding Source need not include anything that users | |
| 148 | + | can regenerate automatically from other parts of the Corresponding | |
| 149 | + | Source. | |
| 150 | + | ||
| 151 | + | The Corresponding Source for a work in source code form is that | |
| 152 | + | same work. | |
| 153 | + | ||
| 154 | + | 2. Basic Permissions. | |
| 155 | + | ||
| 156 | + | All rights granted under this License are granted for the term of | |
| 157 | + | copyright on the Program, and are irrevocable provided the stated | |
| 158 | + | conditions are met. This License explicitly affirms your unlimited | |
| 159 | + | permission to run the unmodified Program. The output from running a | |
| 160 | + | covered work is covered by this License only if the output, given its | |
| 161 | + | content, constitutes a covered work. This License acknowledges your | |
| 162 | + | rights of fair use or other equivalent, as provided by copyright law. | |
| 163 | + | ||
| 164 | + | You may make, run and propagate covered works that you do not | |
| 165 | + | convey, without conditions so long as your license otherwise remains | |
| 166 | + | in force. You may convey covered works to others for the sole purpose | |
| 167 | + | of having them make modifications exclusively for you, or provide you | |
| 168 | + | with facilities for running those works, provided that you comply with | |
| 169 | + | the terms of this License in conveying all material for which you do | |
| 170 | + | not control copyright. Those thus making or running the covered works | |
| 171 | + | for you must do so exclusively on your behalf, under your direction | |
| 172 | + | and control, on terms that prohibit them from making any copies of | |
| 173 | + | your copyrighted material outside their relationship with you. | |
| 174 | + | ||
| 175 | + | Conveying under any other circumstances is permitted solely under | |
| 176 | + | the conditions stated below. Sublicensing is not allowed; section 10 | |
| 177 | + | makes it unnecessary. | |
| 178 | + | ||
| 179 | + | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. | |
| 180 | + | ||
| 181 | + | No covered work shall be deemed part of an effective technological | |
| 182 | + | measure under any applicable law fulfilling obligations under article | |
| 183 | + | 11 of the WIPO copyright treaty adopted on 20 December 1996, or | |
| 184 | + | similar laws prohibiting or restricting circumvention of such | |
| 185 | + | measures. | |
| 186 | + | ||
| 187 | + | When you convey a covered work, you waive any legal power to forbid | |
| 188 | + | circumvention of technological measures to the extent such circumvention | |
| 189 | + | is effected by exercising rights under this License with respect to | |
| 190 | + | the covered work, and you disclaim any intention to limit operation or | |
| 191 | + | modification of the work as a means of enforcing, against the work's | |
| 192 | + | users, your or third parties' legal rights to forbid circumvention of | |
| 193 | + | technological measures. | |
| 194 | + | ||
| 195 | + | 4. Conveying Verbatim Copies. | |
| 196 | + | ||
| 197 | + | You may convey verbatim copies of the Program's source code as you | |
| 198 | + | receive it, in any medium, provided that you conspicuously and | |
| 199 | + | appropriately publish on each copy an appropriate copyright notice; | |
| 200 | + | keep intact all notices stating that this License and any | |
| 201 | + | non-permissive terms added in accord with section 7 apply to the code; | |
| 202 | + | keep intact all notices of the absence of any warranty; and give all | |
| 203 | + | recipients a copy of this License along with the Program. | |
| 204 | + | ||
| 205 | + | You may charge any price or no price for each copy that you convey, | |
| 206 | + | and you may offer support or warranty protection for a fee. | |
| 207 | + | ||
| 208 | + | 5. Conveying Modified Source Versions. | |
| 209 | + | ||
| 210 | + | You may convey a work based on the Program, or the modifications to | |
| 211 | + | produce it from the Program, in the form of source code under the | |
| 212 | + | terms of section 4, provided that you also meet all of these conditions: | |
| 213 | + | ||
| 214 | + | a) The work must carry prominent notices stating that you modified | |
| 215 | + | it, and giving a relevant date. | |
| 216 | + | ||
| 217 | + | b) The work must carry prominent notices stating that it is | |
| 218 | + | released under this License and any conditions added under section | |
| 219 | + | 7. This requirement modifies the requirement in section 4 to | |
| 220 | + | "keep intact all notices". | |
| 221 | + | ||
| 222 | + | c) You must license the entire work, as a whole, under this | |
| 223 | + | License to anyone who comes into possession of a copy. This | |
| 224 | + | License will therefore apply, along with any applicable section 7 | |
| 225 | + | additional terms, to the whole of the work, and all its parts, | |
| 226 | + | regardless of how they are packaged. This License gives no | |
| 227 | + | permission to license the work in any other way, but it does not | |
| 228 | + | invalidate such permission if you have separately received it. | |
| 229 | + | ||
| 230 | + | d) If the work has interactive user interfaces, each must display | |
| 231 | + | Appropriate Legal Notices; however, if the Program has interactive | |
| 232 | + | interfaces that do not display Appropriate Legal Notices, your | |
| 233 | + | work need not make them do so. | |
| 234 | + | ||
| 235 | + | A compilation of a covered work with other separate and independent | |
| 236 | + | works, which are not by their nature extensions of the covered work, | |
| 237 | + | and which are not combined with it such as to form a larger program, | |
| 238 | + | in or on a volume of a storage or distribution medium, is called an | |
| 239 | + | "aggregate" if the compilation and its resulting copyright are not | |
| 240 | + | used to limit the access or legal rights of the compilation's users | |
| 241 | + | beyond what the individual works permit. Inclusion of a covered work | |
| 242 | + | in an aggregate does not cause this License to apply to the other | |
| 243 | + | parts of the aggregate. | |
| 244 | + | ||
| 245 | + | 6. Conveying Non-Source Forms. | |
| 246 | + | ||
| 247 | + | You may convey a covered work in object code form under the terms | |
| 248 | + | of sections 4 and 5, provided that you also convey the | |
| 249 | + | machine-readable Corresponding Source under the terms of this License, | |
| 250 | + | in one of these ways: | |
| 251 | + | ||
| 252 | + | a) Convey the object code in, or embodied in, a physical product | |
| 253 | + | (including a physical distribution medium), accompanied by the | |
| 254 | + | Corresponding Source fixed on a durable physical medium | |
| 255 | + | customarily used for software interchange. | |
| 256 | + | ||
| 257 | + | b) Convey the object code in, or embodied in, a physical product | |
| 258 | + | (including a physical distribution medium), accompanied by a | |
| 259 | + | written offer, valid for at least three years and valid for as | |
| 260 | + | long as you offer spare parts or customer support for that product | |
| 261 | + | model, to give anyone who possesses the object code either (1) a | |
| 262 | + | copy of the Corresponding Source for all the software in the | |
| 263 | + | product that is covered by this License, on a durable physical | |
| 264 | + | medium customarily used for software interchange, for a price no | |
| 265 | + | more than your reasonable cost of physically performing this | |
| 266 | + | conveying of source, or (2) access to copy the | |
| 267 | + | Corresponding Source from a network server at no charge. | |
| 268 | + | ||
| 269 | + | c) Convey individual copies of the object code with a copy of the | |
| 270 | + | written offer to provide the Corresponding Source. This | |
| 271 | + | alternative is allowed only occasionally and noncommercially, and | |
| 272 | + | only if you received the object code with such an offer, in accord | |
| 273 | + | with subsection 6b. | |
| 274 | + | ||
| 275 | + | d) Convey the object code by offering access from a designated | |
| 276 | + | place (gratis or for a charge), and offer equivalent access to the | |
| 277 | + | Corresponding Source in the same way through the same place at no | |
| 278 | + | further charge. You need not require recipients to copy the | |
| 279 | + | Corresponding Source along with the object code. If the place to | |
| 280 | + | copy the object code is a network server, the Corresponding Source | |
| 281 | + | may be on a different server (operated by you or a third party) | |
| 282 | + | that supports equivalent copying facilities, provided you maintain | |
| 283 | + | clear directions next to the object code saying where to find the | |
| 284 | + | Corresponding Source. Regardless of what server hosts the | |
| 285 | + | Corresponding Source, you remain obligated to ensure that it is | |
| 286 | + | available for as long as needed to satisfy these requirements. | |
| 287 | + | ||
| 288 | + | e) Convey the object code using peer-to-peer transmission, provided | |
| 289 | + | you inform other peers where the object code and Corresponding | |
| 290 | + | Source of the work are being offered to the general public at no | |
| 291 | + | charge under subsection 6d. | |
| 292 | + | ||
| 293 | + | A separable portion of the object code, whose source code is excluded | |
| 294 | + | from the Corresponding Source as a System Library, need not be | |
| 295 | + | included in conveying the object code work. | |
| 296 | + | ||
| 297 | + | A "User Product" is either (1) a "consumer product", which means any | |
| 298 | + | tangible personal property which is normally used for personal, family, | |
| 299 | + | or household purposes, or (2) anything designed or sold for incorporation | |
| 300 | + | into a dwelling. In determining whether a product is a consumer product, | |
| 301 | + | doubtful cases shall be resolved in favor of coverage. For a particular | |
| 302 | + | product received by a particular user, "normally used" refers to a | |
| 303 | + | typical or common use of that class of product, regardless of the status | |
| 304 | + | of the particular user or of the way in which the particular user | |
| 305 | + | actually uses, or expects or is expected to use, the product. A product | |
| 306 | + | is a consumer product regardless of whether the product has substantial | |
| 307 | + | commercial, industrial or non-consumer uses, unless such uses represent | |
| 308 | + | the only significant mode of use of the product. | |
| 309 | + | ||
| 310 | + | "Installation Information" for a User Product means any methods, | |
| 311 | + | procedures, authorization keys, or other information required to install | |
| 312 | + | and execute modified versions of a covered work in that User Product from | |
| 313 | + | a modified version of its Corresponding Source. The information must | |
| 314 | + | suffice to ensure that the continued functioning of the modified object | |
| 315 | + | code is in no case prevented or interfered with solely because | |
| 316 | + | modification has been made. | |
| 317 | + | ||
| 318 | + | If you convey an object code work under this section in, or with, or | |
| 319 | + | specifically for use in, a User Product, and the conveying occurs as | |
| 320 | + | part of a transaction in which the right of possession and use of the | |
| 321 | + | User Product is transferred to the recipient in perpetuity or for a | |
| 322 | + | fixed term (regardless of how the transaction is characterized), the | |
| 323 | + | Corresponding Source conveyed under this section must be accompanied | |
| 324 | + | by the Installation Information. But this requirement does not apply | |
| 325 | + | if neither you nor any third party retains the ability to install | |
| 326 | + | modified object code on the User Product (for example, the work has | |
| 327 | + | been installed in ROM). | |
| 328 | + | ||
| 329 | + | The requirement to provide Installation Information does not include a | |
| 330 | + | requirement to continue to provide support service, warranty, or updates | |
| 331 | + | for a work that has been modified or installed by the recipient, or for | |
| 332 | + | the User Product in which it has been modified or installed. Access to a | |
| 333 | + | network may be denied when the modification itself materially and | |
| 334 | + | adversely affects the operation of the network or violates the rules and | |
| 335 | + | protocols for communication across the network. | |
| 336 | + | ||
| 337 | + | Corresponding Source conveyed, and Installation Information provided, | |
| 338 | + | in accord with this section must be in a format that is publicly | |
| 339 | + | documented (and with an implementation available to the public in | |
| 340 | + | source code form), and must require no special password or key for | |
| 341 | + | unpacking, reading or copying. | |
| 342 | + | ||
| 343 | + | 7. Additional Terms. | |
| 344 | + | ||
| 345 | + | "Additional permissions" are terms that supplement the terms of this | |
| 346 | + | License by making exceptions from one or more of its conditions. | |
| 347 | + | Additional permissions that are applicable to the entire Program shall | |
| 348 | + | be treated as though they were included in this License, to the extent | |
| 349 | + | that they are valid under applicable law. If additional permissions | |
| 350 | + | apply only to part of the Program, that part may be used separately | |
| 351 | + | under those permissions, but the entire Program remains governed by | |
| 352 | + | this License without regard to the additional permissions. | |
| 353 | + | ||
| 354 | + | When you convey a copy of a covered work, you may at your option | |
| 355 | + | remove any additional permissions from that copy, or from any part of | |
| 356 | + | it. (Additional permissions may be written to require their own | |
| 357 | + | removal in certain cases when you modify the work.) You may place | |
| 358 | + | additional permissions on material, added by you to a covered work, | |
| 359 | + | for which you have or can give appropriate copyright permission. | |
| 360 | + | ||
| 361 | + | Notwithstanding any other provision of this License, for material you | |
| 362 | + | add to a covered work, you may (if authorized by the copyright holders of | |
| 363 | + | that material) supplement the terms of this License with terms: | |
| 364 | + | ||
| 365 | + | a) Disclaiming warranty or limiting liability differently from the | |
| 366 | + | terms of sections 15 and 16 of this License; or | |
| 367 | + | ||
| 368 | + | b) Requiring preservation of specified reasonable legal notices or | |
| 369 | + | author attributions in that material or in the Appropriate Legal | |
| 370 | + | Notices displayed by works containing it; or | |
| 371 | + | ||
| 372 | + | c) Prohibiting misrepresentation of the origin of that material, or | |
| 373 | + | requiring that modified versions of such material be marked in | |
| 374 | + | reasonable ways as different from the original version; or | |
| 375 | + | ||
| 376 | + | d) Limiting the use for publicity purposes of names of licensors or | |
| 377 | + | authors of the material; or | |
| 378 | + | ||
| 379 | + | e) Declining to grant rights under trademark law for use of some | |
| 380 | + | trade names, trademarks, or service marks; or | |
| 381 | + | ||
| 382 | + | f) Requiring indemnification of licensors and authors of that | |
| 383 | + | material by anyone who conveys the material (or modified versions of | |
| 384 | + | it) with contractual assumptions of liability to the recipient, for | |
| 385 | + | any liability that these contractual assumptions directly impose on | |
| 386 | + | those licensors and authors. | |
| 387 | + | ||
| 388 | + | All other non-permissive additional terms are considered "further | |
| 389 | + | restrictions" within the meaning of section 10. If the Program as you | |
| 390 | + | received it, or any part of it, contains a notice stating that it is | |
| 391 | + | governed by this License along with a term that is a further | |
| 392 | + | restriction, you may remove that term. If a license document contains | |
| 393 | + | a further restriction but permits relicensing or conveying under this | |
| 394 | + | License, you may add to a covered work material governed by the terms | |
| 395 | + | of that license document, provided that the further restriction does | |
| 396 | + | not survive such relicensing or conveying. | |
| 397 | + | ||
| 398 | + | If you add terms to a covered work in accord with this section, you | |
| 399 | + | must place, in the relevant source files, a statement of the | |
| 400 | + | additional terms that apply to those files, or a notice indicating | |
| 401 | + | where to find the applicable terms. | |
| 402 | + | ||
| 403 | + | Additional terms, permissive or non-permissive, may be stated in the | |
| 404 | + | form of a separately written license, or stated as exceptions; | |
| 405 | + | the above requirements apply either way. | |
| 406 | + | ||
| 407 | + | 8. Termination. | |
| 408 | + | ||
| 409 | + | You may not propagate or modify a covered work except as expressly | |
| 410 | + | provided under this License. Any attempt otherwise to propagate or | |
| 411 | + | modify it is void, and will automatically terminate your rights under | |
| 412 | + | this License (including any patent licenses granted under the third | |
| 413 | + | paragraph of section 11). | |
| 414 | + | ||
| 415 | + | However, if you cease all violation of this License, then your | |
| 416 | + | license from a particular copyright holder is reinstated (a) | |
| 417 | + | provisionally, unless and until the copyright holder explicitly and | |
| 418 | + | finally terminates your license, and (b) permanently, if the copyright | |
| 419 | + | holder fails to notify you of the violation by some reasonable means | |
| 420 | + | prior to 60 days after the cessation. | |
| 421 | + | ||
| 422 | + | Moreover, your license from a particular copyright holder is | |
| 423 | + | reinstated permanently if the copyright holder notifies you of the | |
| 424 | + | violation by some reasonable means, this is the first time you have | |
| 425 | + | received notice of violation of this License (for any work) from that | |
| 426 | + | copyright holder, and you cure the violation prior to 30 days after | |
| 427 | + | your receipt of the notice. | |
| 428 | + | ||
| 429 | + | Termination of your rights under this section does not terminate the | |
| 430 | + | licenses of parties who have received copies or rights from you under | |
| 431 | + | this License. If your rights have been terminated and not permanently | |
| 432 | + | reinstated, you do not qualify to receive new licenses for the same | |
| 433 | + | material under section 10. | |
| 434 | + | ||
| 435 | + | 9. Acceptance Not Required for Having Copies. | |
| 436 | + | ||
| 437 | + | You are not required to accept this License in order to receive or | |
| 438 | + | run a copy of the Program. Ancillary propagation of a covered work | |
| 439 | + | occurring solely as a consequence of using peer-to-peer transmission | |
| 440 | + | to receive a copy likewise does not require acceptance. However, | |
| 441 | + | nothing other than this License grants you permission to propagate or | |
| 442 | + | modify any covered work. These actions infringe copyright if you do | |
| 443 | + | not accept this License. Therefore, by modifying or propagating a | |
| 444 | + | covered work, you indicate your acceptance of this License to do so. | |
| 445 | + | ||
| 446 | + | 10. Automatic Licensing of Downstream Recipients. | |
| 447 | + | ||
| 448 | + | Each time you convey a covered work, the recipient automatically | |
| 449 | + | receives a license from the original licensors, to run, modify and | |
| 450 | + | propagate that work, subject to this License. You are not responsible | |
| 451 | + | for enforcing compliance by third parties with this License. | |
| 452 | + | ||
| 453 | + | An "entity transaction" is a transaction transferring control of an | |
| 454 | + | organization, or substantially all assets of one, or subdividing an | |
| 455 | + | organization, or merging organizations. If propagation of a covered | |
| 456 | + | work results from an entity transaction, each party to that | |
| 457 | + | transaction who receives a copy of the work also receives whatever | |
| 458 | + | licenses to the work the party's predecessor in interest had or could | |
| 459 | + | give under the previous paragraph, plus a right to possession of the | |
| 460 | + | Corresponding Source of the work from the predecessor in interest, if | |
| 461 | + | the predecessor has it or can get it with reasonable efforts. | |
| 462 | + | ||
| 463 | + | You may not impose any further restrictions on the exercise of the | |
| 464 | + | rights granted or affirmed under this License. For example, you may | |
| 465 | + | not impose a license fee, royalty, or other charge for exercise of | |
| 466 | + | rights granted under this License, and you may not initiate litigation | |
| 467 | + | (including a cross-claim or counterclaim in a lawsuit) alleging that | |
| 468 | + | any patent claim is infringed by making, using, selling, offering for | |
| 469 | + | sale, or importing the Program or any portion of it. | |
| 470 | + | ||
| 471 | + | 11. Patents. | |
| 472 | + | ||
| 473 | + | A "contributor" is a copyright holder who authorizes use under this | |
| 474 | + | License of the Program or a work on which the Program is based. The | |
| 475 | + | work thus licensed is called the contributor's "contributor version". | |
| 476 | + | ||
| 477 | + | A contributor's "essential patent claims" are all patent claims | |
| 478 | + | owned or controlled by the contributor, whether already acquired or | |
| 479 | + | hereafter acquired, that would be infringed by some manner, permitted | |
| 480 | + | by this License, of making, using, or selling its contributor version, | |
| 481 | + | but do not include claims that would be infringed only as a | |
| 482 | + | consequence of further modification of the contributor version. For | |
| 483 | + | purposes of this definition, "control" includes the right to grant | |
| 484 | + | patent sublicenses in a manner consistent with the requirements of | |
| 485 | + | this License. | |
| 486 | + | ||
| 487 | + | Each contributor grants you a non-exclusive, worldwide, royalty-free | |
| 488 | + | patent license under the contributor's essential patent claims, to | |
| 489 | + | make, use, sell, offer for sale, import and otherwise run, modify and | |
| 490 | + | propagate the contents of its contributor version. | |
| 491 | + | ||
| 492 | + | In the following three paragraphs, a "patent license" is any express | |
| 493 | + | agreement or commitment, however denominated, not to enforce a patent | |
| 494 | + | (such as an express permission to practice a patent or covenant not to | |
| 495 | + | sue for patent infringement). To "grant" such a patent license to a | |
| 496 | + | party means to make such an agreement or commitment not to enforce a | |
| 497 | + | patent against the party. | |
| 498 | + | ||
| 499 | + | If you convey a covered work, knowingly relying on a patent license, | |
| 500 | + | and the Corresponding Source of the work is not available for anyone | |
| 501 | + | to copy, free of charge and under the terms of this License, through a | |
| 502 | + | publicly available network server or other readily accessible means, | |
| 503 | + | then you must either (1) cause the Corresponding Source to be so | |
| 504 | + | available, or (2) arrange to deprive yourself of the benefit of the | |
| 505 | + | patent license for this particular work, or (3) arrange, in a manner | |
| 506 | + | consistent with the requirements of this License, to extend the patent | |
| 507 | + | license to downstream recipients. "Knowingly relying" means you have | |
| 508 | + | actual knowledge that, but for the patent license, your conveying the | |
| 509 | + | covered work in a country, or your recipient's use of the covered work | |
| 510 | + | in a country, would infringe one or more identifiable patents in that | |
| 511 | + | country that you have reason to believe are valid. | |
| 512 | + | ||
| 513 | + | If, pursuant to or in connection with a single transaction or | |
| 514 | + | arrangement, you convey, or propagate by procuring conveyance of, a | |
| 515 | + | covered work, and grant a patent license to some of the parties | |
| 516 | + | receiving the covered work authorizing them to use, propagate, modify | |
| 517 | + | or convey a specific copy of the covered work, then the patent license | |
| 518 | + | you grant is automatically extended to all recipients of the covered | |
| 519 | + | work and works based on it. | |
| 520 | + | ||
| 521 | + | A patent license is "discriminatory" if it does not include within | |
| 522 | + | the scope of its coverage, prohibits the exercise of, or is | |
| 523 | + | conditioned on the non-exercise of one or more of the rights that are | |
| 524 | + | specifically granted under this License. You may not convey a covered | |
| 525 | + | work if you are a party to an arrangement with a third party that is | |
| 526 | + | in the business of distributing software, under which you make payment | |
| 527 | + | to the third party based on the extent of your activity of conveying | |
| 528 | + | the work, and under which the third party grants, to any of the | |
| 529 | + | parties who would receive the covered work from you, a discriminatory | |
| 530 | + | patent license (a) in connection with copies of the covered work | |
| 531 | + | conveyed by you (or copies made from those copies), or (b) primarily | |
| 532 | + | for and in connection with specific products or compilations that | |
| 533 | + | contain the covered work, unless you entered into that arrangement, | |
| 534 | + | or that patent license was granted, prior to 28 March 2007. | |
| 535 | + | ||
| 536 | + | Nothing in this License shall be construed as excluding or limiting | |
| 537 | + | any implied license or other defenses to infringement that may | |
| 538 | + | otherwise be available to you under applicable patent law. | |
| 539 | + | ||
| 540 | + | 12. No Surrender of Others' Freedom. | |
| 541 | + | ||
| 542 | + | If conditions are imposed on you (whether by court order, agreement or | |
| 543 | + | otherwise) that contradict the conditions of this License, they do not | |
| 544 | + | excuse you from the conditions of this License. If you cannot convey a | |
| 545 | + | covered work so as to satisfy simultaneously your obligations under this | |
| 546 | + | License and any other pertinent obligations, then as a consequence you may | |
| 547 | + | not convey it at all. For example, if you agree to terms that obligate you | |
| 548 | + | to collect a royalty for further conveying from those to whom you convey | |
| 549 | + | the Program, the only way you could satisfy both those terms and this | |
| 550 | + | License would be to refrain entirely from conveying the Program. | |
| 551 | + | ||
| 552 | + | 13. Use with the GNU Affero General Public License. | |
| 553 | + | ||
| 554 | + | Notwithstanding any other provision of this License, you have | |
| 555 | + | permission to link or combine any covered work with a work licensed | |
| 556 | + | under version 3 of the GNU Affero General Public License into a single | |
| 557 | + | combined work, and to convey the resulting work. The terms of this | |
| 558 | + | License will continue to apply to the part which is the covered work, | |
| 559 | + | but the special requirements of the GNU Affero General Public License, | |
| 560 | + | section 13, concerning interaction through a network will apply to the | |
| 561 | + | combination as such. | |
| 562 | + | ||
| 563 | + | 14. Revised Versions of this License. | |
| 564 | + | ||
| 565 | + | The Free Software Foundation may publish revised and/or new versions of | |
| 566 | + | the GNU General Public License from time to time. Such new versions will | |
| 567 | + | be similar in spirit to the present version, but may differ in detail to | |
| 568 | + | address new problems or concerns. | |
| 569 | + | ||
| 570 | + | Each version is given a distinguishing version number. If the | |
| 571 | + | Program specifies that a certain numbered version of the GNU General | |
| 572 | + | Public License "or any later version" applies to it, you have the | |
| 573 | + | option of following the terms and conditions either of that numbered | |
| 574 | + | version or of any later version published by the Free Software | |
| 575 | + | Foundation. If the Program does not specify a version number of the | |
| 576 | + | GNU General Public License, you may choose any version ever published | |
| 577 | + | by the Free Software Foundation. | |
| 578 | + | ||
| 579 | + | If the Program specifies that a proxy can decide which future | |
| 580 | + | versions of the GNU General Public License can be used, that proxy's | |
| 581 | + | public statement of acceptance of a version permanently authorizes you | |
| 582 | + | to choose that version for the Program. | |
| 583 | + | ||
| 584 | + | Later license versions may give you additional or different | |
| 585 | + | permissions. However, no additional obligations are imposed on any | |
| 586 | + | author or copyright holder as a result of your choosing to follow a | |
| 587 | + | later version. | |
| 588 | + | ||
| 589 | + | 15. Disclaimer of Warranty. | |
| 590 | + | ||
| 591 | + | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY | |
| 592 | + | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT | |
| 593 | + | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY | |
| 594 | + | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, | |
| 595 | + | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR | |
| 596 | + | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM | |
| 597 | + | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF | |
| 598 | + | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. | |
| 599 | + | ||
| 600 | + | 16. Limitation of Liability. | |
| 601 | + | ||
| 602 | + | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING | |
| 603 | + | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS | |
| 604 | + | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY | |
| 605 | + | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE | |
| 606 | + | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF | |
| 607 | + | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD | |
| 608 | + | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), | |
| 609 | + | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF | |
| 610 | + | SUCH DAMAGES. | |
| 611 | + | ||
| 612 | + | 17. Interpretation of Sections 15 and 16. | |
| 613 | + | ||
| 614 | + | If the disclaimer of warranty and limitation of liability provided | |
| 615 | + | above cannot be given local legal effect according to their terms, | |
| 616 | + | reviewing courts shall apply local law that most closely approximates | |
| 617 | + | an absolute waiver of all civil liability in connection with the | |
| 618 | + | Program, unless a warranty or assumption of liability accompanies a | |
| 619 | + | copy of the Program in return for a fee. | |
| 620 | + | ||
| 621 | + | END OF TERMS AND CONDITIONS | |
| 622 | + | ||
| 623 | + | How to Apply These Terms to Your New Programs | |
| 624 | + | ||
| 625 | + | If you develop a new program, and you want it to be of the greatest | |
| 626 | + | possible use to the public, the best way to achieve this is to make it | |
| 627 | + | free software which everyone can redistribute and change under these terms. | |
| 628 | + | ||
| 629 | + | To do so, attach the following notices to the program. It is safest | |
| 630 | + | to attach them to the start of each source file to most effectively | |
| 631 | + | state the exclusion of warranty; and each file should have at least | |
| 632 | + | the "copyright" line and a pointer to where the full notice is found. | |
| 633 | + | ||
| 634 | + | <one line to give the program's name and a brief idea of what it does.> | |
| 635 | + | Copyright (C) <year> <name of author> | |
| 636 | + | ||
| 637 | + | This program is free software: you can redistribute it and/or modify | |
| 638 | + | it under the terms of the GNU General Public License as published by | |
| 639 | + | the Free Software Foundation, either version 3 of the License, or | |
| 640 | + | (at your option) any later version. | |
| 641 | + | ||
| 642 | + | This program is distributed in the hope that it will be useful, | |
| 643 | + | but WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 644 | + | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
| 645 | + | GNU General Public License for more details. | |
| 646 | + | ||
| 647 | + | You should have received a copy of the GNU General Public License | |
| 648 | + | along with this program. If not, see <https://www.gnu.org/licenses/>. | |
| 649 | + | ||
| 650 | + | Also add information on how to contact you by electronic and paper mail. | |
| 651 | + | ||
| 652 | + | If the program does terminal interaction, make it output a short | |
| 653 | + | notice like this when it starts in an interactive mode: | |
| 654 | + | ||
| 655 | + | <program> Copyright (C) <year> <name of author> | |
| 656 | + | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. | |
| 657 | + | This is free software, and you are welcome to redistribute it | |
| 658 | + | under certain conditions; type `show c' for details. | |
| 659 | + | ||
| 660 | + | The hypothetical commands `show w' and `show c' should show the appropriate | |
| 661 | + | parts of the General Public License. Of course, your program's commands | |
| 662 | + | might be different; for a GUI interface, you would use an "about box". | |
| 663 | + | ||
| 664 | + | You should also get your employer (if you work as a programmer) or school, | |
| 665 | + | if any, to sign a "copyright disclaimer" for the program, if necessary. | |
| 666 | + | For more information on this, and how to apply and follow the GNU GPL, see | |
| 667 | + | <https://www.gnu.org/licenses/>. | |
| 668 | + | ||
| 669 | + | The GNU General Public License does not permit incorporating your program | |
| 670 | + | into proprietary programs. If your program is a subroutine library, you | |
| 671 | + | may consider it more useful to permit linking proprietary applications with | |
| 672 | + | the library. If this is what you want to do, use the GNU Lesser General | |
| 673 | + | Public License instead of this License. But first, please read | |
| 674 | + | <https://www.gnu.org/licenses/why-not-lgpl.html>. | |
| @@ -0,0 +1,674 @@ | |||||
| 1 | + | GNU GENERAL PUBLIC LICENSE | |||
| 2 | + | Version 3, 29 June 2007 | |||
| 3 | + | ||||
| 4 | + | Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/> | |||
| 5 | + | Everyone is permitted to copy and distribute verbatim copies | |||
| 6 | + | of this license document, but changing it is not allowed. | |||
| 7 | + | ||||
| 8 | + | Preamble | |||
| 9 | + | ||||
| 10 | + | The GNU General Public License is a free, copyleft license for | |||
| 11 | + | software and other kinds of works. | |||
| 12 | + | ||||
| 13 | + | The licenses for most software and other practical works are designed | |||
| 14 | + | to take away your freedom to share and change the works. By contrast, | |||
| 15 | + | the GNU General Public License is intended to guarantee your freedom to | |||
| 16 | + | share and change all versions of a program--to make sure it remains free | |||
| 17 | + | software for all its users. We, the Free Software Foundation, use the | |||
| 18 | + | GNU General Public License for most of our software; it applies also to | |||
| 19 | + | any other work released this way by its authors. You can apply it to | |||
| 20 | + | your programs, too. | |||
| 21 | + | ||||
| 22 | + | When we speak of free software, we are referring to freedom, not | |||
| 23 | + | price. Our General Public Licenses are designed to make sure that you | |||
| 24 | + | have the freedom to distribute copies of free software (and charge for | |||
| 25 | + | them if you wish), that you receive source code or can get it if you | |||
| 26 | + | want it, that you can change the software or use pieces of it in new | |||
| 27 | + | free programs, and that you know you can do these things. | |||
| 28 | + | ||||
| 29 | + | To protect your rights, we need to prevent others from denying you | |||
| 30 | + | these rights or asking you to surrender the rights. Therefore, you have | |||
| 31 | + | certain responsibilities if you distribute copies of the software, or if | |||
| 32 | + | you modify it: responsibilities to respect the freedom of others. | |||
| 33 | + | ||||
| 34 | + | For example, if you distribute copies of such a program, whether | |||
| 35 | + | gratis or for a fee, you must pass on to the recipients the same | |||
| 36 | + | freedoms that you received. You must make sure that they, too, receive | |||
| 37 | + | or can get the source code. And you must show them these terms so they | |||
| 38 | + | know their rights. | |||
| 39 | + | ||||
| 40 | + | Developers that use the GNU GPL protect your rights with two steps: | |||
| 41 | + | (1) assert copyright on the software, and (2) offer you this License | |||
| 42 | + | giving you legal permission to copy, distribute and/or modify it. | |||
| 43 | + | ||||
| 44 | + | For the developers' and authors' protection, the GPL clearly explains | |||
| 45 | + | that there is no warranty for this free software. For both users' and | |||
| 46 | + | authors' sake, the GPL requires that modified versions be marked as | |||
| 47 | + | changed, so that their problems will not be attributed erroneously to | |||
| 48 | + | authors of previous versions. | |||
| 49 | + | ||||
| 50 | + | Some devices are designed to deny users access to install or run | |||
| 51 | + | modified versions of the software inside them, although the manufacturer | |||
| 52 | + | can do so. This is fundamentally incompatible with the aim of | |||
| 53 | + | protecting users' freedom to change the software. The systematic | |||
| 54 | + | pattern of such abuse occurs in the area of products for individuals to | |||
| 55 | + | use, which is precisely where it is most unacceptable. Therefore, we | |||
| 56 | + | have designed this version of the GPL to prohibit the practice for those | |||
| 57 | + | products. If such problems arise substantially in other domains, we | |||
| 58 | + | stand ready to extend this provision to those domains in future versions | |||
| 59 | + | of the GPL, as needed to protect the freedom of users. | |||
| 60 | + | ||||
| 61 | + | Finally, every program is threatened constantly by software patents. | |||
| 62 | + | States should not allow patents to restrict development and use of | |||
| 63 | + | software on general-purpose computers, but in those that do, we wish to | |||
| 64 | + | avoid the special danger that patents applied to a free program could | |||
| 65 | + | make it effectively proprietary. To prevent this, the GPL assures that | |||
| 66 | + | patents cannot be used to render the program non-free. | |||
| 67 | + | ||||
| 68 | + | The precise terms and conditions for copying, distribution and | |||
| 69 | + | modification follow. | |||
| 70 | + | ||||
| 71 | + | TERMS AND CONDITIONS | |||
| 72 | + | ||||
| 73 | + | 0. Definitions. | |||
| 74 | + | ||||
| 75 | + | "This License" refers to version 3 of the GNU General Public License. | |||
| 76 | + | ||||
| 77 | + | "Copyright" also means copyright-like laws that apply to other kinds of | |||
| 78 | + | works, such as semiconductor masks. | |||
| 79 | + | ||||
| 80 | + | "The Program" refers to any copyrightable work licensed under this | |||
| 81 | + | License. Each licensee is addressed as "you". "Licensees" and | |||
| 82 | + | "recipients" may be individuals or organizations. | |||
| 83 | + | ||||
| 84 | + | To "modify" a work means to copy from or adapt all or part of the work | |||
| 85 | + | in a fashion requiring copyright permission, other than the making of an | |||
| 86 | + | exact copy. The resulting work is called a "modified version" of the | |||
| 87 | + | earlier work or a work "based on" the earlier work. | |||
| 88 | + | ||||
| 89 | + | A "covered work" means either the unmodified Program or a work based | |||
| 90 | + | on the Program. | |||
| 91 | + | ||||
| 92 | + | To "propagate" a work means to do anything with it that, without | |||
| 93 | + | permission, would make you directly or secondarily liable for | |||
| 94 | + | infringement under applicable copyright law, except executing it on a | |||
| 95 | + | computer or modifying a private copy. Propagation includes copying, | |||
| 96 | + | distribution (with or without modification), making available to the | |||
| 97 | + | public, and in some countries other activities as well. | |||
| 98 | + | ||||
| 99 | + | To "convey" a work means any kind of propagation that enables other | |||
| 100 | + | parties to make or receive copies. Mere interaction with a user through | |||
| 101 | + | a computer network, with no transfer of a copy, is not conveying. | |||
| 102 | + | ||||
| 103 | + | An interactive user interface displays "Appropriate Legal Notices" | |||
| 104 | + | to the extent that it includes a convenient and prominently visible | |||
| 105 | + | feature that (1) displays an appropriate copyright notice, and (2) | |||
| 106 | + | tells the user that there is no warranty for the work (except to the | |||
| 107 | + | extent that warranties are provided), that licensees may convey the | |||
| 108 | + | work under this License, and how to view a copy of this License. If | |||
| 109 | + | the interface presents a list of user commands or options, such as a | |||
| 110 | + | menu, a prominent item in the list meets this criterion. | |||
| 111 | + | ||||
| 112 | + | 1. Source Code. | |||
| 113 | + | ||||
| 114 | + | The "source code" for a work means the preferred form of the work | |||
| 115 | + | for making modifications to it. "Object code" means any non-source | |||
| 116 | + | form of a work. | |||
| 117 | + | ||||
| 118 | + | A "Standard Interface" means an interface that either is an official | |||
| 119 | + | standard defined by a recognized standards body, or, in the case of | |||
| 120 | + | interfaces specified for a particular programming language, one that | |||
| 121 | + | is widely used among developers working in that language. | |||
| 122 | + | ||||
| 123 | + | The "System Libraries" of an executable work include anything, other | |||
| 124 | + | than the work as a whole, that (a) is included in the normal form of | |||
| 125 | + | packaging a Major Component, but which is not part of that Major | |||
| 126 | + | Component, and (b) serves only to enable use of the work with that | |||
| 127 | + | Major Component, or to implement a Standard Interface for which an | |||
| 128 | + | implementation is available to the public in source code form. A | |||
| 129 | + | "Major Component", in this context, means a major essential component | |||
| 130 | + | (kernel, window system, and so on) of the specific operating system | |||
| 131 | + | (if any) on which the executable work runs, or a compiler used to | |||
| 132 | + | produce the work, or an object code interpreter used to run it. | |||
| 133 | + | ||||
| 134 | + | The "Corresponding Source" for a work in object code form means all | |||
| 135 | + | the source code needed to generate, install, and (for an executable | |||
| 136 | + | work) run the object code and to modify the work, including scripts to | |||
| 137 | + | control those activities. However, it does not include the work's | |||
| 138 | + | System Libraries, or general-purpose tools or generally available free | |||
| 139 | + | programs which are used unmodified in performing those activities but | |||
| 140 | + | which are not part of the work. For example, Corresponding Source | |||
| 141 | + | includes interface definition files associated with source files for | |||
| 142 | + | the work, and the source code for shared libraries and dynamically | |||
| 143 | + | linked subprograms that the work is specifically designed to require, | |||
| 144 | + | such as by intimate data communication or control flow between those | |||
| 145 | + | subprograms and other parts of the work. | |||
| 146 | + | ||||
| 147 | + | The Corresponding Source need not include anything that users | |||
| 148 | + | can regenerate automatically from other parts of the Corresponding | |||
| 149 | + | Source. | |||
| 150 | + | ||||
| 151 | + | The Corresponding Source for a work in source code form is that | |||
| 152 | + | same work. | |||
| 153 | + | ||||
| 154 | + | 2. Basic Permissions. | |||
| 155 | + | ||||
| 156 | + | All rights granted under this License are granted for the term of | |||
| 157 | + | copyright on the Program, and are irrevocable provided the stated | |||
| 158 | + | conditions are met. This License explicitly affirms your unlimited | |||
| 159 | + | permission to run the unmodified Program. The output from running a | |||
| 160 | + | covered work is covered by this License only if the output, given its | |||
| 161 | + | content, constitutes a covered work. This License acknowledges your | |||
| 162 | + | rights of fair use or other equivalent, as provided by copyright law. | |||
| 163 | + | ||||
| 164 | + | You may make, run and propagate covered works that you do not | |||
| 165 | + | convey, without conditions so long as your license otherwise remains | |||
| 166 | + | in force. You may convey covered works to others for the sole purpose | |||
| 167 | + | of having them make modifications exclusively for you, or provide you | |||
| 168 | + | with facilities for running those works, provided that you comply with | |||
| 169 | + | the terms of this License in conveying all material for which you do | |||
| 170 | + | not control copyright. Those thus making or running the covered works | |||
| 171 | + | for you must do so exclusively on your behalf, under your direction | |||
| 172 | + | and control, on terms that prohibit them from making any copies of | |||
| 173 | + | your copyrighted material outside their relationship with you. | |||
| 174 | + | ||||
| 175 | + | Conveying under any other circumstances is permitted solely under | |||
| 176 | + | the conditions stated below. Sublicensing is not allowed; section 10 | |||
| 177 | + | makes it unnecessary. | |||
| 178 | + | ||||
| 179 | + | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. | |||
| 180 | + | ||||
| 181 | + | No covered work shall be deemed part of an effective technological | |||
| 182 | + | measure under any applicable law fulfilling obligations under article | |||
| 183 | + | 11 of the WIPO copyright treaty adopted on 20 December 1996, or | |||
| 184 | + | similar laws prohibiting or restricting circumvention of such | |||
| 185 | + | measures. | |||
| 186 | + | ||||
| 187 | + | When you convey a covered work, you waive any legal power to forbid | |||
| 188 | + | circumvention of technological measures to the extent such circumvention | |||
| 189 | + | is effected by exercising rights under this License with respect to | |||
| 190 | + | the covered work, and you disclaim any intention to limit operation or | |||
| 191 | + | modification of the work as a means of enforcing, against the work's | |||
| 192 | + | users, your or third parties' legal rights to forbid circumvention of | |||
| 193 | + | technological measures. | |||
| 194 | + | ||||
| 195 | + | 4. Conveying Verbatim Copies. | |||
| 196 | + | ||||
| 197 | + | You may convey verbatim copies of the Program's source code as you | |||
| 198 | + | receive it, in any medium, provided that you conspicuously and | |||
| 199 | + | appropriately publish on each copy an appropriate copyright notice; | |||
| 200 | + | keep intact all notices stating that this License and any | |||
| 201 | + | non-permissive terms added in accord with section 7 apply to the code; | |||
| 202 | + | keep intact all notices of the absence of any warranty; and give all | |||
| 203 | + | recipients a copy of this License along with the Program. | |||
| 204 | + | ||||
| 205 | + | You may charge any price or no price for each copy that you convey, | |||
| 206 | + | and you may offer support or warranty protection for a fee. | |||
| 207 | + | ||||
| 208 | + | 5. Conveying Modified Source Versions. | |||
| 209 | + | ||||
| 210 | + | You may convey a work based on the Program, or the modifications to | |||
| 211 | + | produce it from the Program, in the form of source code under the | |||
| 212 | + | terms of section 4, provided that you also meet all of these conditions: | |||
| 213 | + | ||||
| 214 | + | a) The work must carry prominent notices stating that you modified | |||
| 215 | + | it, and giving a relevant date. | |||
| 216 | + | ||||
| 217 | + | b) The work must carry prominent notices stating that it is | |||
| 218 | + | released under this License and any conditions added under section | |||
| 219 | + | 7. This requirement modifies the requirement in section 4 to | |||
| 220 | + | "keep intact all notices". | |||
| 221 | + | ||||
| 222 | + | c) You must license the entire work, as a whole, under this | |||
| 223 | + | License to anyone who comes into possession of a copy. This | |||
| 224 | + | License will therefore apply, along with any applicable section 7 | |||
| 225 | + | additional terms, to the whole of the work, and all its parts, | |||
| 226 | + | regardless of how they are packaged. This License gives no | |||
| 227 | + | permission to license the work in any other way, but it does not | |||
| 228 | + | invalidate such permission if you have separately received it. | |||
| 229 | + | ||||
| 230 | + | d) If the work has interactive user interfaces, each must display | |||
| 231 | + | Appropriate Legal Notices; however, if the Program has interactive | |||
| 232 | + | interfaces that do not display Appropriate Legal Notices, your | |||
| 233 | + | work need not make them do so. | |||
| 234 | + | ||||
| 235 | + | A compilation of a covered work with other separate and independent | |||
| 236 | + | works, which are not by their nature extensions of the covered work, | |||
| 237 | + | and which are not combined with it such as to form a larger program, | |||
| 238 | + | in or on a volume of a storage or distribution medium, is called an | |||
| 239 | + | "aggregate" if the compilation and its resulting copyright are not | |||
| 240 | + | used to limit the access or legal rights of the compilation's users | |||
| 241 | + | beyond what the individual works permit. Inclusion of a covered work | |||
| 242 | + | in an aggregate does not cause this License to apply to the other | |||
| 243 | + | parts of the aggregate. | |||
| 244 | + | ||||
| 245 | + | 6. Conveying Non-Source Forms. | |||
| 246 | + | ||||
| 247 | + | You may convey a covered work in object code form under the terms | |||
| 248 | + | of sections 4 and 5, provided that you also convey the | |||
| 249 | + | machine-readable Corresponding Source under the terms of this License, | |||
| 250 | + | in one of these ways: | |||
| 251 | + | ||||
| 252 | + | a) Convey the object code in, or embodied in, a physical product | |||
| 253 | + | (including a physical distribution medium), accompanied by the | |||
| 254 | + | Corresponding Source fixed on a durable physical medium | |||
| 255 | + | customarily used for software interchange. | |||
| 256 | + | ||||
| 257 | + | b) Convey the object code in, or embodied in, a physical product | |||
| 258 | + | (including a physical distribution medium), accompanied by a | |||
| 259 | + | written offer, valid for at least three years and valid for as | |||
| 260 | + | long as you offer spare parts or customer support for that product | |||
| 261 | + | model, to give anyone who possesses the object code either (1) a | |||
| 262 | + | copy of the Corresponding Source for all the software in the | |||
| 263 | + | product that is covered by this License, on a durable physical | |||
| 264 | + | medium customarily used for software interchange, for a price no | |||
| 265 | + | more than your reasonable cost of physically performing this | |||
| 266 | + | conveying of source, or (2) access to copy the | |||
| 267 | + | Corresponding Source from a network server at no charge. | |||
| 268 | + | ||||
| 269 | + | c) Convey individual copies of the object code with a copy of the | |||
| 270 | + | written offer to provide the Corresponding Source. This | |||
| 271 | + | alternative is allowed only occasionally and noncommercially, and | |||
| 272 | + | only if you received the object code with such an offer, in accord | |||
| 273 | + | with subsection 6b. | |||
| 274 | + | ||||
| 275 | + | d) Convey the object code by offering access from a designated | |||
| 276 | + | place (gratis or for a charge), and offer equivalent access to the | |||
| 277 | + | Corresponding Source in the same way through the same place at no | |||
| 278 | + | further charge. You need not require recipients to copy the | |||
| 279 | + | Corresponding Source along with the object code. If the place to | |||
| 280 | + | copy the object code is a network server, the Corresponding Source | |||
| 281 | + | may be on a different server (operated by you or a third party) | |||
| 282 | + | that supports equivalent copying facilities, provided you maintain | |||
| 283 | + | clear directions next to the object code saying where to find the | |||
| 284 | + | Corresponding Source. Regardless of what server hosts the | |||
| 285 | + | Corresponding Source, you remain obligated to ensure that it is | |||
| 286 | + | available for as long as needed to satisfy these requirements. | |||
| 287 | + | ||||
| 288 | + | e) Convey the object code using peer-to-peer transmission, provided | |||
| 289 | + | you inform other peers where the object code and Corresponding | |||
| 290 | + | Source of the work are being offered to the general public at no | |||
| 291 | + | charge under subsection 6d. | |||
| 292 | + | ||||
| 293 | + | A separable portion of the object code, whose source code is excluded | |||
| 294 | + | from the Corresponding Source as a System Library, need not be | |||
| 295 | + | included in conveying the object code work. | |||
| 296 | + | ||||
| 297 | + | A "User Product" is either (1) a "consumer product", which means any | |||
| 298 | + | tangible personal property which is normally used for personal, family, | |||
| 299 | + | or household purposes, or (2) anything designed or sold for incorporation | |||
| 300 | + | into a dwelling. In determining whether a product is a consumer product, | |||
| 301 | + | doubtful cases shall be resolved in favor of coverage. For a particular | |||
| 302 | + | product received by a particular user, "normally used" refers to a | |||
| 303 | + | typical or common use of that class of product, regardless of the status | |||
| 304 | + | of the particular user or of the way in which the particular user | |||
| 305 | + | actually uses, or expects or is expected to use, the product. A product | |||
| 306 | + | is a consumer product regardless of whether the product has substantial | |||
| 307 | + | commercial, industrial or non-consumer uses, unless such uses represent | |||
| 308 | + | the only significant mode of use of the product. | |||
| 309 | + | ||||
| 310 | + | "Installation Information" for a User Product means any methods, | |||
| 311 | + | procedures, authorization keys, or other information required to install | |||
| 312 | + | and execute modified versions of a covered work in that User Product from | |||
| 313 | + | a modified version of its Corresponding Source. The information must | |||
| 314 | + | suffice to ensure that the continued functioning of the modified object | |||
| 315 | + | code is in no case prevented or interfered with solely because | |||
| 316 | + | modification has been made. | |||
| 317 | + | ||||
| 318 | + | If you convey an object code work under this section in, or with, or | |||
| 319 | + | specifically for use in, a User Product, and the conveying occurs as | |||
| 320 | + | part of a transaction in which the right of possession and use of the | |||
| 321 | + | User Product is transferred to the recipient in perpetuity or for a | |||
| 322 | + | fixed term (regardless of how the transaction is characterized), the | |||
| 323 | + | Corresponding Source conveyed under this section must be accompanied | |||
| 324 | + | by the Installation Information. But this requirement does not apply | |||
| 325 | + | if neither you nor any third party retains the ability to install | |||
| 326 | + | modified object code on the User Product (for example, the work has | |||
| 327 | + | been installed in ROM). | |||
| 328 | + | ||||
| 329 | + | The requirement to provide Installation Information does not include a | |||
| 330 | + | requirement to continue to provide support service, warranty, or updates | |||
| 331 | + | for a work that has been modified or installed by the recipient, or for | |||
| 332 | + | the User Product in which it has been modified or installed. Access to a | |||
| 333 | + | network may be denied when the modification itself materially and | |||
| 334 | + | adversely affects the operation of the network or violates the rules and | |||
| 335 | + | protocols for communication across the network. | |||
| 336 | + | ||||
| 337 | + | Corresponding Source conveyed, and Installation Information provided, | |||
| 338 | + | in accord with this section must be in a format that is publicly | |||
| 339 | + | documented (and with an implementation available to the public in | |||
| 340 | + | source code form), and must require no special password or key for | |||
| 341 | + | unpacking, reading or copying. | |||
| 342 | + | ||||
| 343 | + | 7. Additional Terms. | |||
| 344 | + | ||||
| 345 | + | "Additional permissions" are terms that supplement the terms of this | |||
| 346 | + | License by making exceptions from one or more of its conditions. | |||
| 347 | + | Additional permissions that are applicable to the entire Program shall | |||
| 348 | + | be treated as though they were included in this License, to the extent | |||
| 349 | + | that they are valid under applicable law. If additional permissions | |||
| 350 | + | apply only to part of the Program, that part may be used separately | |||
| 351 | + | under those permissions, but the entire Program remains governed by | |||
| 352 | + | this License without regard to the additional permissions. | |||
| 353 | + | ||||
| 354 | + | When you convey a copy of a covered work, you may at your option | |||
| 355 | + | remove any additional permissions from that copy, or from any part of | |||
| 356 | + | it. (Additional permissions may be written to require their own | |||
| 357 | + | removal in certain cases when you modify the work.) You may place | |||
| 358 | + | additional permissions on material, added by you to a covered work, | |||
| 359 | + | for which you have or can give appropriate copyright permission. | |||
| 360 | + | ||||
| 361 | + | Notwithstanding any other provision of this License, for material you | |||
| 362 | + | add to a covered work, you may (if authorized by the copyright holders of | |||
| 363 | + | that material) supplement the terms of this License with terms: | |||
| 364 | + | ||||
| 365 | + | a) Disclaiming warranty or limiting liability differently from the | |||
| 366 | + | terms of sections 15 and 16 of this License; or | |||
| 367 | + | ||||
| 368 | + | b) Requiring preservation of specified reasonable legal notices or | |||
| 369 | + | author attributions in that material or in the Appropriate Legal | |||
| 370 | + | Notices displayed by works containing it; or | |||
| 371 | + | ||||
| 372 | + | c) Prohibiting misrepresentation of the origin of that material, or | |||
| 373 | + | requiring that modified versions of such material be marked in | |||
| 374 | + | reasonable ways as different from the original version; or | |||
| 375 | + | ||||
| 376 | + | d) Limiting the use for publicity purposes of names of licensors or | |||
| 377 | + | authors of the material; or | |||
| 378 | + | ||||
| 379 | + | e) Declining to grant rights under trademark law for use of some | |||
| 380 | + | trade names, trademarks, or service marks; or | |||
| 381 | + | ||||
| 382 | + | f) Requiring indemnification of licensors and authors of that | |||
| 383 | + | material by anyone who conveys the material (or modified versions of | |||
| 384 | + | it) with contractual assumptions of liability to the recipient, for | |||
| 385 | + | any liability that these contractual assumptions directly impose on | |||
| 386 | + | those licensors and authors. | |||
| 387 | + | ||||
| 388 | + | All other non-permissive additional terms are considered "further | |||
| 389 | + | restrictions" within the meaning of section 10. If the Program as you | |||
| 390 | + | received it, or any part of it, contains a notice stating that it is | |||
| 391 | + | governed by this License along with a term that is a further | |||
| 392 | + | restriction, you may remove that term. If a license document contains | |||
| 393 | + | a further restriction but permits relicensing or conveying under this | |||
| 394 | + | License, you may add to a covered work material governed by the terms | |||
| 395 | + | of that license document, provided that the further restriction does | |||
| 396 | + | not survive such relicensing or conveying. | |||
| 397 | + | ||||
| 398 | + | If you add terms to a covered work in accord with this section, you | |||
| 399 | + | must place, in the relevant source files, a statement of the | |||
| 400 | + | additional terms that apply to those files, or a notice indicating | |||
| 401 | + | where to find the applicable terms. | |||
| 402 | + | ||||
| 403 | + | Additional terms, permissive or non-permissive, may be stated in the | |||
| 404 | + | form of a separately written license, or stated as exceptions; | |||
| 405 | + | the above requirements apply either way. | |||
| 406 | + | ||||
| 407 | + | 8. Termination. | |||
| 408 | + | ||||
| 409 | + | You may not propagate or modify a covered work except as expressly | |||
| 410 | + | provided under this License. Any attempt otherwise to propagate or | |||
| 411 | + | modify it is void, and will automatically terminate your rights under | |||
| 412 | + | this License (including any patent licenses granted under the third | |||
| 413 | + | paragraph of section 11). | |||
| 414 | + | ||||
| 415 | + | However, if you cease all violation of this License, then your | |||
| 416 | + | license from a particular copyright holder is reinstated (a) | |||
| 417 | + | provisionally, unless and until the copyright holder explicitly and | |||
| 418 | + | finally terminates your license, and (b) permanently, if the copyright | |||
| 419 | + | holder fails to notify you of the violation by some reasonable means | |||
| 420 | + | prior to 60 days after the cessation. | |||
| 421 | + | ||||
| 422 | + | Moreover, your license from a particular copyright holder is | |||
| 423 | + | reinstated permanently if the copyright holder notifies you of the | |||
| 424 | + | violation by some reasonable means, this is the first time you have | |||
| 425 | + | received notice of violation of this License (for any work) from that | |||
| 426 | + | copyright holder, and you cure the violation prior to 30 days after | |||
| 427 | + | your receipt of the notice. | |||
| 428 | + | ||||
| 429 | + | Termination of your rights under this section does not terminate the | |||
| 430 | + | licenses of parties who have received copies or rights from you under | |||
| 431 | + | this License. If your rights have been terminated and not permanently | |||
| 432 | + | reinstated, you do not qualify to receive new licenses for the same | |||
| 433 | + | material under section 10. | |||
| 434 | + | ||||
| 435 | + | 9. Acceptance Not Required for Having Copies. | |||
| 436 | + | ||||
| 437 | + | You are not required to accept this License in order to receive or | |||
| 438 | + | run a copy of the Program. Ancillary propagation of a covered work | |||
| 439 | + | occurring solely as a consequence of using peer-to-peer transmission | |||
| 440 | + | to receive a copy likewise does not require acceptance. However, | |||
| 441 | + | nothing other than this License grants you permission to propagate or | |||
| 442 | + | modify any covered work. These actions infringe copyright if you do | |||
| 443 | + | not accept this License. Therefore, by modifying or propagating a | |||
| 444 | + | covered work, you indicate your acceptance of this License to do so. | |||
| 445 | + | ||||
| 446 | + | 10. Automatic Licensing of Downstream Recipients. | |||
| 447 | + | ||||
| 448 | + | Each time you convey a covered work, the recipient automatically | |||
| 449 | + | receives a license from the original licensors, to run, modify and | |||
| 450 | + | propagate that work, subject to this License. You are not responsible | |||
| 451 | + | for enforcing compliance by third parties with this License. | |||
| 452 | + | ||||
| 453 | + | An "entity transaction" is a transaction transferring control of an | |||
| 454 | + | organization, or substantially all assets of one, or subdividing an | |||
| 455 | + | organization, or merging organizations. If propagation of a covered | |||
| 456 | + | work results from an entity transaction, each party to that | |||
| 457 | + | transaction who receives a copy of the work also receives whatever | |||
| 458 | + | licenses to the work the party's predecessor in interest had or could | |||
| 459 | + | give under the previous paragraph, plus a right to possession of the | |||
| 460 | + | Corresponding Source of the work from the predecessor in interest, if | |||
| 461 | + | the predecessor has it or can get it with reasonable efforts. | |||
| 462 | + | ||||
| 463 | + | You may not impose any further restrictions on the exercise of the | |||
| 464 | + | rights granted or affirmed under this License. For example, you may | |||
| 465 | + | not impose a license fee, royalty, or other charge for exercise of | |||
| 466 | + | rights granted under this License, and you may not initiate litigation | |||
| 467 | + | (including a cross-claim or counterclaim in a lawsuit) alleging that | |||
| 468 | + | any patent claim is infringed by making, using, selling, offering for | |||
| 469 | + | sale, or importing the Program or any portion of it. | |||
| 470 | + | ||||
| 471 | + | 11. Patents. | |||
| 472 | + | ||||
| 473 | + | A "contributor" is a copyright holder who authorizes use under this | |||
| 474 | + | License of the Program or a work on which the Program is based. The | |||
| 475 | + | work thus licensed is called the contributor's "contributor version". | |||
| 476 | + | ||||
| 477 | + | A contributor's "essential patent claims" are all patent claims | |||
| 478 | + | owned or controlled by the contributor, whether already acquired or | |||
| 479 | + | hereafter acquired, that would be infringed by some manner, permitted | |||
| 480 | + | by this License, of making, using, or selling its contributor version, | |||
| 481 | + | but do not include claims that would be infringed only as a | |||
| 482 | + | consequence of further modification of the contributor version. For | |||
| 483 | + | purposes of this definition, "control" includes the right to grant | |||
| 484 | + | patent sublicenses in a manner consistent with the requirements of | |||
| 485 | + | this License. | |||
| 486 | + | ||||
| 487 | + | Each contributor grants you a non-exclusive, worldwide, royalty-free | |||
| 488 | + | patent license under the contributor's essential patent claims, to | |||
| 489 | + | make, use, sell, offer for sale, import and otherwise run, modify and | |||
| 490 | + | propagate the contents of its contributor version. | |||
| 491 | + | ||||
| 492 | + | In the following three paragraphs, a "patent license" is any express | |||
| 493 | + | agreement or commitment, however denominated, not to enforce a patent | |||
| 494 | + | (such as an express permission to practice a patent or covenant not to | |||
| 495 | + | sue for patent infringement). To "grant" such a patent license to a | |||
| 496 | + | party means to make such an agreement or commitment not to enforce a | |||
| 497 | + | patent against the party. | |||
| 498 | + | ||||
| 499 | + | If you convey a covered work, knowingly relying on a patent license, | |||
| 500 | + | and the Corresponding Source of the work is not available for anyone | |||
| 501 | + | to copy, free of charge and under the terms of this License, through a | |||
| 502 | + | publicly available network server or other readily accessible means, | |||
| 503 | + | then you must either (1) cause the Corresponding Source to be so | |||
| 504 | + | available, or (2) arrange to deprive yourself of the benefit of the | |||
| 505 | + | patent license for this particular work, or (3) arrange, in a manner | |||
| 506 | + | consistent with the requirements of this License, to extend the patent | |||
| 507 | + | license to downstream recipients. "Knowingly relying" means you have | |||
| 508 | + | actual knowledge that, but for the patent license, your conveying the | |||
| 509 | + | covered work in a country, or your recipient's use of the covered work | |||
| 510 | + | in a country, would infringe one or more identifiable patents in that | |||
| 511 | + | country that you have reason to believe are valid. | |||
| 512 | + | ||||
| 513 | + | If, pursuant to or in connection with a single transaction or | |||
| 514 | + | arrangement, you convey, or propagate by procuring conveyance of, a | |||
| 515 | + | covered work, and grant a patent license to some of the parties | |||
| 516 | + | receiving the covered work authorizing them to use, propagate, modify | |||
| 517 | + | or convey a specific copy of the covered work, then the patent license | |||
| 518 | + | you grant is automatically extended to all recipients of the covered | |||
| 519 | + | work and works based on it. | |||
| 520 | + | ||||
| 521 | + | A patent license is "discriminatory" if it does not include within | |||
| 522 | + | the scope of its coverage, prohibits the exercise of, or is | |||
| 523 | + | conditioned on the non-exercise of one or more of the rights that are | |||
| 524 | + | specifically granted under this License. You may not convey a covered | |||
| 525 | + | work if you are a party to an arrangement with a third party that is | |||
| 526 | + | in the business of distributing software, under which you make payment | |||
| 527 | + | to the third party based on the extent of your activity of conveying | |||
| 528 | + | the work, and under which the third party grants, to any of the | |||
| 529 | + | parties who would receive the covered work from you, a discriminatory | |||
| 530 | + | patent license (a) in connection with copies of the covered work | |||
| 531 | + | conveyed by you (or copies made from those copies), or (b) primarily | |||
| 532 | + | for and in connection with specific products or compilations that | |||
| 533 | + | contain the covered work, unless you entered into that arrangement, | |||
| 534 | + | or that patent license was granted, prior to 28 March 2007. | |||
| 535 | + | ||||
| 536 | + | Nothing in this License shall be construed as excluding or limiting | |||
| 537 | + | any implied license or other defenses to infringement that may | |||
| 538 | + | otherwise be available to you under applicable patent law. | |||
| 539 | + | ||||
| 540 | + | 12. No Surrender of Others' Freedom. | |||
| 541 | + | ||||
| 542 | + | If conditions are imposed on you (whether by court order, agreement or | |||
| 543 | + | otherwise) that contradict the conditions of this License, they do not | |||
| 544 | + | excuse you from the conditions of this License. If you cannot convey a | |||
| 545 | + | covered work so as to satisfy simultaneously your obligations under this | |||
| 546 | + | License and any other pertinent obligations, then as a consequence you may | |||
| 547 | + | not convey it at all. For example, if you agree to terms that obligate you | |||
| 548 | + | to collect a royalty for further conveying from those to whom you convey | |||
| 549 | + | the Program, the only way you could satisfy both those terms and this | |||
| 550 | + | License would be to refrain entirely from conveying the Program. | |||
| 551 | + | ||||
| 552 | + | 13. Use with the GNU Affero General Public License. | |||
| 553 | + | ||||
| 554 | + | Notwithstanding any other provision of this License, you have | |||
| 555 | + | permission to link or combine any covered work with a work licensed | |||
| 556 | + | under version 3 of the GNU Affero General Public License into a single | |||
| 557 | + | combined work, and to convey the resulting work. The terms of this | |||
| 558 | + | License will continue to apply to the part which is the covered work, | |||
| 559 | + | but the special requirements of the GNU Affero General Public License, | |||
| 560 | + | section 13, concerning interaction through a network will apply to the | |||
| 561 | + | combination as such. | |||
| 562 | + | ||||
| 563 | + | 14. Revised Versions of this License. | |||
| 564 | + | ||||
| 565 | + | The Free Software Foundation may publish revised and/or new versions of | |||
| 566 | + | the GNU General Public License from time to time. Such new versions will | |||
| 567 | + | be similar in spirit to the present version, but may differ in detail to | |||
| 568 | + | address new problems or concerns. | |||
| 569 | + | ||||
| 570 | + | Each version is given a distinguishing version number. If the | |||
| 571 | + | Program specifies that a certain numbered version of the GNU General | |||
| 572 | + | Public License "or any later version" applies to it, you have the | |||
| 573 | + | option of following the terms and conditions either of that numbered | |||
| 574 | + | version or of any later version published by the Free Software | |||
| 575 | + | Foundation. If the Program does not specify a version number of the | |||
| 576 | + | GNU General Public License, you may choose any version ever published | |||
| 577 | + | by the Free Software Foundation. | |||
| 578 | + | ||||
| 579 | + | If the Program specifies that a proxy can decide which future | |||
| 580 | + | versions of the GNU General Public License can be used, that proxy's | |||
| 581 | + | public statement of acceptance of a version permanently authorizes you | |||
| 582 | + | to choose that version for the Program. | |||
| 583 | + | ||||
| 584 | + | Later license versions may give you additional or different | |||
| 585 | + | permissions. However, no additional obligations are imposed on any | |||
| 586 | + | author or copyright holder as a result of your choosing to follow a | |||
| 587 | + | later version. | |||
| 588 | + | ||||
| 589 | + | 15. Disclaimer of Warranty. | |||
| 590 | + | ||||
| 591 | + | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY | |||
| 592 | + | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT | |||
| 593 | + | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY | |||
| 594 | + | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, | |||
| 595 | + | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR | |||
| 596 | + | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM | |||
| 597 | + | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF | |||
| 598 | + | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. | |||
| 599 | + | ||||
| 600 | + | 16. Limitation of Liability. | |||
| 601 | + | ||||
| 602 | + | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING | |||
| 603 | + | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS | |||
| 604 | + | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY | |||
| 605 | + | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE | |||
| 606 | + | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF | |||
| 607 | + | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD | |||
| 608 | + | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), | |||
| 609 | + | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF | |||
| 610 | + | SUCH DAMAGES. | |||
| 611 | + | ||||
| 612 | + | 17. Interpretation of Sections 15 and 16. | |||
| 613 | + | ||||
| 614 | + | If the disclaimer of warranty and limitation of liability provided | |||
| 615 | + | above cannot be given local legal effect according to their terms, | |||
| 616 | + | reviewing courts shall apply local law that most closely approximates | |||
| 617 | + | an absolute waiver of all civil liability in connection with the | |||
| 618 | + | Program, unless a warranty or assumption of liability accompanies a | |||
| 619 | + | copy of the Program in return for a fee. | |||
| 620 | + | ||||
| 621 | + | END OF TERMS AND CONDITIONS | |||
| 622 | + | ||||
| 623 | + | How to Apply These Terms to Your New Programs | |||
| 624 | + | ||||
| 625 | + | If you develop a new program, and you want it to be of the greatest | |||
| 626 | + | possible use to the public, the best way to achieve this is to make it | |||
| 627 | + | free software which everyone can redistribute and change under these terms. | |||
| 628 | + | ||||
| 629 | + | To do so, attach the following notices to the program. It is safest | |||
| 630 | + | to attach them to the start of each source file to most effectively | |||
| 631 | + | state the exclusion of warranty; and each file should have at least | |||
| 632 | + | the "copyright" line and a pointer to where the full notice is found. | |||
| 633 | + | ||||
| 634 | + | <one line to give the program's name and a brief idea of what it does.> | |||
| 635 | + | Copyright (C) <year> <name of author> | |||
| 636 | + | ||||
| 637 | + | This program is free software: you can redistribute it and/or modify | |||
| 638 | + | it under the terms of the GNU General Public License as published by | |||
| 639 | + | the Free Software Foundation, either version 3 of the License, or | |||
| 640 | + | (at your option) any later version. | |||
| 641 | + | ||||
| 642 | + | This program is distributed in the hope that it will be useful, | |||
| 643 | + | but WITHOUT ANY WARRANTY; without even the implied warranty of | |||
| 644 | + | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |||
| 645 | + | GNU General Public License for more details. | |||
| 646 | + | ||||
| 647 | + | You should have received a copy of the GNU General Public License | |||
| 648 | + | along with this program. If not, see <https://www.gnu.org/licenses/>. | |||
| 649 | + | ||||
| 650 | + | Also add information on how to contact you by electronic and paper mail. | |||
| 651 | + | ||||
| 652 | + | If the program does terminal interaction, make it output a short | |||
| 653 | + | notice like this when it starts in an interactive mode: | |||
| 654 | + | ||||
| 655 | + | <program> Copyright (C) <year> <name of author> | |||
| 656 | + | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. | |||
| 657 | + | This is free software, and you are welcome to redistribute it | |||
| 658 | + | under certain conditions; type `show c' for details. | |||
| 659 | + | ||||
| 660 | + | The hypothetical commands `show w' and `show c' should show the appropriate | |||
| 661 | + | parts of the General Public License. Of course, your program's commands | |||
| 662 | + | might be different; for a GUI interface, you would use an "about box". | |||
| 663 | + | ||||
| 664 | + | You should also get your employer (if you work as a programmer) or school, | |||
| 665 | + | if any, to sign a "copyright disclaimer" for the program, if necessary. | |||
| 666 | + | For more information on this, and how to apply and follow the GNU GPL, see | |||
| 667 | + | <https://www.gnu.org/licenses/>. | |||
| 668 | + | ||||
| 669 | + | The GNU General Public License does not permit incorporating your program | |||
| 670 | + | into proprietary programs. If your program is a subroutine library, you | |||
| 671 | + | may consider it more useful to permit linking proprietary applications with | |||
| 672 | + | the library. If this is what you want to do, use the GNU Lesser General | |||
| 673 | + | Public License instead of this License. But first, please read | |||
| 674 | + | <https://www.gnu.org/licenses/why-not-lgpl.html>. | |||
A Makefile +57 -0
| @@ -0,0 +1,57 @@ | |||
| 1 | + | .PHONY: bin build test vet race mocks mocks-check fakes-check arch perf-check check | |
| 2 | + | ||
| 3 | + | GOBIN_DIR := $(or $(shell go env GOBIN),$(firstword $(subst :, ,$(shell go env GOPATH)))/bin) | |
| 4 | + | MOCKERY ?= $(GOBIN_DIR)/mockery | |
| 5 | + | HEXCHECK ?= $(GOBIN_DIR)/hexcheck | |
| 6 | + | ||
| 7 | + | # Build a fresh binary. | |
| 8 | + | bin: | |
| 9 | + | CGO_ENABLED=0 go build -o bin/nefercap ./cmd/nefercap | |
| 10 | + | build: | |
| 11 | + | CGO_ENABLED=0 go build ./... | |
| 12 | + | test: | |
| 13 | + | CGO_ENABLED=0 go test ./... | |
| 14 | + | vet: | |
| 15 | + | CGO_ENABLED=0 go vet ./... | |
| 16 | + | race: | |
| 17 | + | # cgo is enabled only for the race test binary. | |
| 18 | + | CGO_ENABLED=1 go test -race ./... | |
| 19 | + | ||
| 20 | + | # Regenerate from scratch so mocks of removed interfaces disappear too. | |
| 21 | + | mocks: | |
| 22 | + | @test -x '$(MOCKERY)' || { echo 'mockery not found or not executable: $(MOCKERY)' >&2; exit 1; } | |
| 23 | + | rm -rf internal/mocks | |
| 24 | + | find internal -name '*_mock_test.go' -delete | |
| 25 | + | $(MOCKERY) | |
| 26 | + | ||
| 27 | + | # Checksum of all generated mocks (paths and contents); empty set is valid. | |
| 28 | + | MOCKSUM = { find internal -type f \( -path 'internal/mocks/*' -o -name '*_mock_test.go' \) | LC_ALL=C sort | xargs -r sha256sum; } | sha256sum | |
| 29 | + | MOCKS := internal/mocks ':(glob)internal/**/*_mock_test.go' | |
| 30 | + | # Regenerate and compare checksums (independent of committed state), then also | |
| 31 | + | # require the mocks to be tracked and clean. | |
| 32 | + | mocks-check: | |
| 33 | + | @before=$$($(MOCKSUM)); \ | |
| 34 | + | $(MAKE) --no-print-directory mocks || exit $$?; \ | |
| 35 | + | after=$$($(MOCKSUM)); \ | |
| 36 | + | [ "$$before" = "$$after" ] || { echo 'generated mocks were stale: review and commit the regenerated files' >&2; exit 1; } | |
| 37 | + | git diff --exit-code -- $(MOCKS) | |
| 38 | + | @test -z "$$(git ls-files --others --exclude-standard -- $(MOCKS))" || { echo 'untracked generated mocks: commit them' >&2; exit 1; } | |
| 39 | + | ||
| 40 | + | # Test doubles come from Mockery only: no handwritten fake/stub/spy types. | |
| 41 | + | # grep exit 1 (no match) passes; 0 (match) and 2 (error) fail. | |
| 42 | + | FAKES := ^\s*type\s+\w*(fake|stub|spy|dummy|mock)\w*|^\s*\w*(fake|stub|spy|dummy|mock)\w*(\[[^]]*\])?\s+(struct|interface)\b | |
| 43 | + | fakes-check: | |
| 44 | + | @dirs=$$(ls -d internal cmd 2>/dev/null); [ -n "$$dirs" ] || exit 0; \ | |
| 45 | + | rc=0; grep -rniE '$(FAKES)' --include='*_test.go' --exclude='*_mock_test.go' $$dirs || rc=$$?; \ | |
| 46 | + | [ $$rc -eq 1 ] || { [ $$rc -eq 0 ] && echo 'handwritten test double: add an interface and a Mockery entry (see AGENTS.md)' >&2; exit 1; } | |
| 47 | + | arch: | |
| 48 | + | $(HEXCHECK) -hexcheck.config .hexcheck.yaml -hexcheck.root . ./... | |
| 49 | + | # Steady-state allocation guards. Extend PERF_TESTS (regexp, exact names) and | |
| 50 | + | # PERF_PKGS as encoder/wayland tests appear. The preflight fails if no listed | |
| 51 | + | # test matches, so the guard cannot pass vacuously. | |
| 52 | + | PERF_TESTS := ^TestFrameAllocations$$ | |
| 53 | + | PERF_PKGS := ./internal/ports | |
| 54 | + | perf-check: | |
| 55 | + | @CGO_ENABLED=0 go test -list '$(PERF_TESTS)' $(PERF_PKGS) | grep -Eq '$(PERF_TESTS)' || { echo 'perf-check: no test matches $(PERF_TESTS) in $(PERF_PKGS)' >&2; exit 1; } | |
| 56 | + | CGO_ENABLED=0 go test $(PERF_PKGS) -run '$(PERF_TESTS)' -count=1 | |
| 57 | + | check: vet test arch fakes-check perf-check | |
| @@ -0,0 +1,57 @@ | |||||
| 1 | + | .PHONY: bin build test vet race mocks mocks-check fakes-check arch perf-check check | |||
| 2 | + | ||||
| 3 | + | GOBIN_DIR := $(or $(shell go env GOBIN),$(firstword $(subst :, ,$(shell go env GOPATH)))/bin) | |||
| 4 | + | MOCKERY ?= $(GOBIN_DIR)/mockery | |||
| 5 | + | HEXCHECK ?= $(GOBIN_DIR)/hexcheck | |||
| 6 | + | ||||
| 7 | + | # Build a fresh binary. | |||
| 8 | + | bin: | |||
| 9 | + | CGO_ENABLED=0 go build -o bin/nefercap ./cmd/nefercap | |||
| 10 | + | build: | |||
| 11 | + | CGO_ENABLED=0 go build ./... | |||
| 12 | + | test: | |||
| 13 | + | CGO_ENABLED=0 go test ./... | |||
| 14 | + | vet: | |||
| 15 | + | CGO_ENABLED=0 go vet ./... | |||
| 16 | + | race: | |||
| 17 | + | # cgo is enabled only for the race test binary. | |||
| 18 | + | CGO_ENABLED=1 go test -race ./... | |||
| 19 | + | ||||
| 20 | + | # Regenerate from scratch so mocks of removed interfaces disappear too. | |||
| 21 | + | mocks: | |||
| 22 | + | @test -x '$(MOCKERY)' || { echo 'mockery not found or not executable: $(MOCKERY)' >&2; exit 1; } | |||
| 23 | + | rm -rf internal/mocks | |||
| 24 | + | find internal -name '*_mock_test.go' -delete | |||
| 25 | + | $(MOCKERY) | |||
| 26 | + | ||||
| 27 | + | # Checksum of all generated mocks (paths and contents); empty set is valid. | |||
| 28 | + | MOCKSUM = { find internal -type f \( -path 'internal/mocks/*' -o -name '*_mock_test.go' \) | LC_ALL=C sort | xargs -r sha256sum; } | sha256sum | |||
| 29 | + | MOCKS := internal/mocks ':(glob)internal/**/*_mock_test.go' | |||
| 30 | + | # Regenerate and compare checksums (independent of committed state), then also | |||
| 31 | + | # require the mocks to be tracked and clean. | |||
| 32 | + | mocks-check: | |||
| 33 | + | @before=$$($(MOCKSUM)); \ | |||
| 34 | + | $(MAKE) --no-print-directory mocks || exit $$?; \ | |||
| 35 | + | after=$$($(MOCKSUM)); \ | |||
| 36 | + | [ "$$before" = "$$after" ] || { echo 'generated mocks were stale: review and commit the regenerated files' >&2; exit 1; } | |||
| 37 | + | git diff --exit-code -- $(MOCKS) | |||
| 38 | + | @test -z "$$(git ls-files --others --exclude-standard -- $(MOCKS))" || { echo 'untracked generated mocks: commit them' >&2; exit 1; } | |||
| 39 | + | ||||
| 40 | + | # Test doubles come from Mockery only: no handwritten fake/stub/spy types. | |||
| 41 | + | # grep exit 1 (no match) passes; 0 (match) and 2 (error) fail. | |||
| 42 | + | FAKES := ^\s*type\s+\w*(fake|stub|spy|dummy|mock)\w*|^\s*\w*(fake|stub|spy|dummy|mock)\w*(\[[^]]*\])?\s+(struct|interface)\b | |||
| 43 | + | fakes-check: | |||
| 44 | + | @dirs=$$(ls -d internal cmd 2>/dev/null); [ -n "$$dirs" ] || exit 0; \ | |||
| 45 | + | rc=0; grep -rniE '$(FAKES)' --include='*_test.go' --exclude='*_mock_test.go' $$dirs || rc=$$?; \ | |||
| 46 | + | [ $$rc -eq 1 ] || { [ $$rc -eq 0 ] && echo 'handwritten test double: add an interface and a Mockery entry (see AGENTS.md)' >&2; exit 1; } | |||
| 47 | + | arch: | |||
| 48 | + | $(HEXCHECK) -hexcheck.config .hexcheck.yaml -hexcheck.root . ./... | |||
| 49 | + | # Steady-state allocation guards. Extend PERF_TESTS (regexp, exact names) and | |||
| 50 | + | # PERF_PKGS as encoder/wayland tests appear. The preflight fails if no listed | |||
| 51 | + | # test matches, so the guard cannot pass vacuously. | |||
| 52 | + | PERF_TESTS := ^TestFrameAllocations$$ | |||
| 53 | + | PERF_PKGS := ./internal/ports | |||
| 54 | + | perf-check: | |||
| 55 | + | @CGO_ENABLED=0 go test -list '$(PERF_TESTS)' $(PERF_PKGS) | grep -Eq '$(PERF_TESTS)' || { echo 'perf-check: no test matches $(PERF_TESTS) in $(PERF_PKGS)' >&2; exit 1; } | |||
| 56 | + | CGO_ENABLED=0 go test $(PERF_PKGS) -run '$(PERF_TESTS)' -count=1 | |||
| 57 | + | check: vet test arch fakes-check perf-check | |||
A go.mod +20 -0
| @@ -0,0 +1,20 @@ | |||
| 1 | + | module github.com/bnema/nefercap | |
| 2 | + | ||
| 3 | + | go 1.27 | |
| 4 | + | ||
| 5 | + | require ( | |
| 6 | + | github.com/bnema/nefergui v0.1.0 | |
| 7 | + | github.com/bnema/wlturbo v0.3.0 | |
| 8 | + | github.com/bnema/zerowrap v1.4.1 | |
| 9 | + | github.com/stretchr/testify v1.12.1 | |
| 10 | + | golang.org/x/sys v0.48.0 | |
| 11 | + | ) | |
| 12 | + | ||
| 13 | + | require ( | |
| 14 | + | github.com/mattn/go-colorable v0.1.15 // indirect | |
| 15 | + | github.com/mattn/go-isatty v0.0.22 // indirect | |
| 16 | + | github.com/rs/zerolog v1.35.1 // indirect | |
| 17 | + | github.com/stretchr/objx v0.5.3 // indirect | |
| 18 | + | go.yaml.in/yaml/v3 v3.0.5 // indirect | |
| 19 | + | gopkg.in/natefinch/lumberjack.v2 v2.2.1 // indirect | |
| 20 | + | ) | |
| @@ -0,0 +1,20 @@ | |||||
| 1 | + | module github.com/bnema/nefercap | |||
| 2 | + | ||||
| 3 | + | go 1.27 | |||
| 4 | + | ||||
| 5 | + | require ( | |||
| 6 | + | github.com/bnema/nefergui v0.1.0 | |||
| 7 | + | github.com/bnema/wlturbo v0.3.0 | |||
| 8 | + | github.com/bnema/zerowrap v1.4.1 | |||
| 9 | + | github.com/stretchr/testify v1.12.1 | |||
| 10 | + | golang.org/x/sys v0.48.0 | |||
| 11 | + | ) | |||
| 12 | + | ||||
| 13 | + | require ( | |||
| 14 | + | github.com/mattn/go-colorable v0.1.15 // indirect | |||
| 15 | + | github.com/mattn/go-isatty v0.0.22 // indirect | |||
| 16 | + | github.com/rs/zerolog v1.35.1 // indirect | |||
| 17 | + | github.com/stretchr/objx v0.5.3 // indirect | |||
| 18 | + | go.yaml.in/yaml/v3 v3.0.5 // indirect | |||
| 19 | + | gopkg.in/natefinch/lumberjack.v2 v2.2.1 // indirect | |||
| 20 | + | ) | |||
A go.sum +50 -0 generated file: collapsed
A internal/logging/logging.go +24 -0
| @@ -0,0 +1,24 @@ | |||
| 1 | + | // Package logging configures component-scoped zerowrap logging. | |
| 2 | + | package logging | |
| 3 | + | ||
| 4 | + | import ( | |
| 5 | + | "context" | |
| 6 | + | "io" | |
| 7 | + | ||
| 8 | + | "github.com/bnema/zerowrap" | |
| 9 | + | ) | |
| 10 | + | ||
| 11 | + | // With attaches a JSON logger at info level, or debug when requested. | |
| 12 | + | // A nil output uses zerowrap's default stderr output. | |
| 13 | + | func With(ctx context.Context, output io.Writer, debug bool) context.Context { | |
| 14 | + | level := "info" | |
| 15 | + | if debug { | |
| 16 | + | level = "debug" | |
| 17 | + | } | |
| 18 | + | return zerowrap.WithCtx(ctx, zerowrap.New(zerowrap.Config{Level: level, Format: "json", Output: output})) | |
| 19 | + | } | |
| 20 | + | ||
| 21 | + | // For derives a component logger. Cache it outside steady-state frame loops. | |
| 22 | + | func For(ctx context.Context, component string) zerowrap.Logger { | |
| 23 | + | return zerowrap.FromCtxWithField(ctx, zerowrap.FieldComponent, component) | |
| 24 | + | } | |
| @@ -0,0 +1,24 @@ | |||||
| 1 | + | // Package logging configures component-scoped zerowrap logging. | |||
| 2 | + | package logging | |||
| 3 | + | ||||
| 4 | + | import ( | |||
| 5 | + | "context" | |||
| 6 | + | "io" | |||
| 7 | + | ||||
| 8 | + | "github.com/bnema/zerowrap" | |||
| 9 | + | ) | |||
| 10 | + | ||||
| 11 | + | // With attaches a JSON logger at info level, or debug when requested. | |||
| 12 | + | // A nil output uses zerowrap's default stderr output. | |||
| 13 | + | func With(ctx context.Context, output io.Writer, debug bool) context.Context { | |||
| 14 | + | level := "info" | |||
| 15 | + | if debug { | |||
| 16 | + | level = "debug" | |||
| 17 | + | } | |||
| 18 | + | return zerowrap.WithCtx(ctx, zerowrap.New(zerowrap.Config{Level: level, Format: "json", Output: output})) | |||
| 19 | + | } | |||
| 20 | + | ||||
| 21 | + | // For derives a component logger. Cache it outside steady-state frame loops. | |||
| 22 | + | func For(ctx context.Context, component string) zerowrap.Logger { | |||
| 23 | + | return zerowrap.FromCtxWithField(ctx, zerowrap.FieldComponent, component) | |||
| 24 | + | } | |||
A internal/logging/logging_test.go +43 -0
| @@ -0,0 +1,43 @@ | |||
| 1 | + | package logging | |
| 2 | + | ||
| 3 | + | import ( | |
| 4 | + | "bytes" | |
| 5 | + | "context" | |
| 6 | + | "encoding/json" | |
| 7 | + | "testing" | |
| 8 | + | ) | |
| 9 | + | ||
| 10 | + | func TestComponent(t *testing.T) { | |
| 11 | + | var output bytes.Buffer | |
| 12 | + | ctx := With(context.Background(), &output, false) | |
| 13 | + | log := For(ctx, "capture") | |
| 14 | + | log.Info().Msg("capture started") | |
| 15 | + | var entry map[string]any | |
| 16 | + | if err := json.Unmarshal(output.Bytes(), &entry); err != nil { | |
| 17 | + | t.Fatal(err) | |
| 18 | + | } | |
| 19 | + | if entry["component"] != "capture" || entry["level"] != "info" || entry["message"] != "capture started" { | |
| 20 | + | t.Fatalf("unexpected entry: %v", entry) | |
| 21 | + | } | |
| 22 | + | } | |
| 23 | + | ||
| 24 | + | func TestDebugLevel(t *testing.T) { | |
| 25 | + | for _, debug := range []bool{false, true} { | |
| 26 | + | var output bytes.Buffer | |
| 27 | + | log := For(With(context.Background(), &output, debug), "app") | |
| 28 | + | log.Debug().Msg("debug enabled") | |
| 29 | + | if !debug { | |
| 30 | + | if output.Len() != 0 { | |
| 31 | + | t.Fatalf("info logger emitted debug: %s", output.Bytes()) | |
| 32 | + | } | |
| 33 | + | continue | |
| 34 | + | } | |
| 35 | + | var entry map[string]any | |
| 36 | + | if err := json.Unmarshal(output.Bytes(), &entry); err != nil { | |
| 37 | + | t.Fatal(err) | |
| 38 | + | } | |
| 39 | + | if entry["component"] != "app" || entry["level"] != "debug" || entry["message"] != "debug enabled" { | |
| 40 | + | t.Fatalf("unexpected debug entry: %v", entry) | |
| 41 | + | } | |
| 42 | + | } | |
| 43 | + | } | |
| @@ -0,0 +1,43 @@ | |||||
| 1 | + | package logging | |||
| 2 | + | ||||
| 3 | + | import ( | |||
| 4 | + | "bytes" | |||
| 5 | + | "context" | |||
| 6 | + | "encoding/json" | |||
| 7 | + | "testing" | |||
| 8 | + | ) | |||
| 9 | + | ||||
| 10 | + | func TestComponent(t *testing.T) { | |||
| 11 | + | var output bytes.Buffer | |||
| 12 | + | ctx := With(context.Background(), &output, false) | |||
| 13 | + | log := For(ctx, "capture") | |||
| 14 | + | log.Info().Msg("capture started") | |||
| 15 | + | var entry map[string]any | |||
| 16 | + | if err := json.Unmarshal(output.Bytes(), &entry); err != nil { | |||
| 17 | + | t.Fatal(err) | |||
| 18 | + | } | |||
| 19 | + | if entry["component"] != "capture" || entry["level"] != "info" || entry["message"] != "capture started" { | |||
| 20 | + | t.Fatalf("unexpected entry: %v", entry) | |||
| 21 | + | } | |||
| 22 | + | } | |||
| 23 | + | ||||
| 24 | + | func TestDebugLevel(t *testing.T) { | |||
| 25 | + | for _, debug := range []bool{false, true} { | |||
| 26 | + | var output bytes.Buffer | |||
| 27 | + | log := For(With(context.Background(), &output, debug), "app") | |||
| 28 | + | log.Debug().Msg("debug enabled") | |||
| 29 | + | if !debug { | |||
| 30 | + | if output.Len() != 0 { | |||
| 31 | + | t.Fatalf("info logger emitted debug: %s", output.Bytes()) | |||
| 32 | + | } | |||
| 33 | + | continue | |||
| 34 | + | } | |||
| 35 | + | var entry map[string]any | |||
| 36 | + | if err := json.Unmarshal(output.Bytes(), &entry); err != nil { | |||
| 37 | + | t.Fatal(err) | |||
| 38 | + | } | |||
| 39 | + | if entry["component"] != "app" || entry["level"] != "debug" || entry["message"] != "debug enabled" { | |||
| 40 | + | t.Fatalf("unexpected debug entry: %v", entry) | |||
| 41 | + | } | |||
| 42 | + | } | |||
| 43 | + | } | |||
A internal/mocks/ports/capture_mock.go +677 -0
| @@ -0,0 +1,677 @@ | |||
| 1 | + | // Code generated by mockery; DO NOT EDIT. | |
| 2 | + | // github.com/vektra/mockery | |
| 3 | + | // template: testify | |
| 4 | + | ||
| 5 | + | package portsmocks | |
| 6 | + | ||
| 7 | + | import ( | |
| 8 | + | "context" | |
| 9 | + | ||
| 10 | + | "github.com/bnema/nefercap/internal/ports" | |
| 11 | + | mock "github.com/stretchr/testify/mock" | |
| 12 | + | ) | |
| 13 | + | ||
| 14 | + | // NewMockSource creates a new instance of MockSource. It also registers a testing interface on the mock and a cleanup function to assert the mocks expectations. | |
| 15 | + | // The first argument is typically a *testing.T value. | |
| 16 | + | func NewMockSource(t interface { | |
| 17 | + | mock.TestingT | |
| 18 | + | Cleanup(func()) | |
| 19 | + | }) *MockSource { | |
| 20 | + | if helper, ok := t.(interface{ Helper() }); ok { | |
| 21 | + | helper.Helper() | |
| 22 | + | } | |
| 23 | + | ||
| 24 | + | mock := &MockSource{} | |
| 25 | + | mock.Mock.Test(t) | |
| 26 | + | ||
| 27 | + | t.Cleanup(func() { | |
| 28 | + | if helper, ok := t.(interface{ Helper() }); ok { | |
| 29 | + | helper.Helper() | |
| 30 | + | } | |
| 31 | + | mock.AssertExpectations(t) | |
| 32 | + | }) | |
| 33 | + | ||
| 34 | + | return mock | |
| 35 | + | } | |
| 36 | + | ||
| 37 | + | // MockSource is an autogenerated mock type for the Source type | |
| 38 | + | type MockSource struct { | |
| 39 | + | mock.Mock | |
| 40 | + | } | |
| 41 | + | ||
| 42 | + | type MockSource_Expecter struct { | |
| 43 | + | mock *mock.Mock | |
| 44 | + | } | |
| 45 | + | ||
| 46 | + | func (_m *MockSource) EXPECT() *MockSource_Expecter { | |
| 47 | + | return &MockSource_Expecter{mock: &_m.Mock} | |
| 48 | + | } | |
| 49 | + | ||
| 50 | + | // Capture provides a mock function for the type MockSource | |
| 51 | + | func (_mock *MockSource) Capture(context1 context.Context, target ports.Target) (ports.Frame, error) { | |
| 52 | + | ret := _mock.Called(context1, target) | |
| 53 | + | ||
| 54 | + | if len(ret) == 0 { | |
| 55 | + | panic("no return value specified for Capture") | |
| 56 | + | } | |
| 57 | + | ||
| 58 | + | var r0 ports.Frame | |
| 59 | + | var r1 error | |
| 60 | + | if returnFunc, ok := ret.Get(0).(func(context.Context, ports.Target) (ports.Frame, error)); ok { | |
| 61 | + | return returnFunc(context1, target) | |
| 62 | + | } | |
| 63 | + | if returnFunc, ok := ret.Get(0).(func(context.Context, ports.Target) ports.Frame); ok { | |
| 64 | + | r0 = returnFunc(context1, target) | |
| 65 | + | } else { | |
| 66 | + | r0 = ret.Get(0).(ports.Frame) | |
| 67 | + | } | |
| 68 | + | if returnFunc, ok := ret.Get(1).(func(context.Context, ports.Target) error); ok { | |
| 69 | + | r1 = returnFunc(context1, target) | |
| 70 | + | } else { | |
| 71 | + | r1 = ret.Error(1) | |
| 72 | + | } | |
| 73 | + | return r0, r1 | |
| 74 | + | } | |
| 75 | + | ||
| 76 | + | // MockSource_Capture_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'Capture' | |
| 77 | + | type MockSource_Capture_Call struct { | |
| 78 | + | *mock.Call | |
| 79 | + | } | |
| 80 | + | ||
| 81 | + | // Capture is a helper method to define mock.On call | |
| 82 | + | // - context1 context.Context | |
| 83 | + | // - target ports.Target | |
| 84 | + | func (_e *MockSource_Expecter) Capture(context1 any, target any) *MockSource_Capture_Call { | |
| 85 | + | return &MockSource_Capture_Call{Call: _e.mock.On("Capture", context1, target)} | |
| 86 | + | } | |
| 87 | + | ||
| 88 | + | func (_c *MockSource_Capture_Call) Run(run func(context1 context.Context, target ports.Target)) *MockSource_Capture_Call { | |
| 89 | + | _c.Call.Run(func(args mock.Arguments) { | |
| 90 | + | var arg0 context.Context | |
| 91 | + | if args[0] != nil { | |
| 92 | + | arg0 = args[0].(context.Context) | |
| 93 | + | } | |
| 94 | + | var arg1 ports.Target | |
| 95 | + | if args[1] != nil { | |
| 96 | + | arg1 = args[1].(ports.Target) | |
| 97 | + | } | |
| 98 | + | run( | |
| 99 | + | arg0, | |
| 100 | + | arg1, | |
| 101 | + | ) | |
| 102 | + | }) | |
| 103 | + | return _c | |
| 104 | + | } | |
| 105 | + | ||
| 106 | + | func (_c *MockSource_Capture_Call) Return(frame ports.Frame, err error) *MockSource_Capture_Call { | |
| 107 | + | _c.Call.Return(frame, err) | |
| 108 | + | return _c | |
| 109 | + | } | |
| 110 | + | ||
| 111 | + | func (_c *MockSource_Capture_Call) RunAndReturn(run func(context1 context.Context, target ports.Target) (ports.Frame, error)) *MockSource_Capture_Call { | |
| 112 | + | _c.Call.Return(run) | |
| 113 | + | return _c | |
| 114 | + | } | |
| 115 | + | ||
| 116 | + | // Close provides a mock function for the type MockSource | |
| 117 | + | func (_mock *MockSource) Close() error { | |
| 118 | + | ret := _mock.Called() | |
| 119 | + | ||
| 120 | + | if len(ret) == 0 { | |
| 121 | + | panic("no return value specified for Close") | |
| 122 | + | } | |
| 123 | + | ||
| 124 | + | var r0 error | |
| 125 | + | if returnFunc, ok := ret.Get(0).(func() error); ok { | |
| 126 | + | r0 = returnFunc() | |
| 127 | + | } else { | |
| 128 | + | r0 = ret.Error(0) | |
| 129 | + | } | |
| 130 | + | return r0 | |
| 131 | + | } | |
| 132 | + | ||
| 133 | + | // MockSource_Close_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'Close' | |
| 134 | + | type MockSource_Close_Call struct { | |
| 135 | + | *mock.Call | |
| 136 | + | } | |
| 137 | + | ||
| 138 | + | // Close is a helper method to define mock.On call | |
| 139 | + | func (_e *MockSource_Expecter) Close() *MockSource_Close_Call { | |
| 140 | + | return &MockSource_Close_Call{Call: _e.mock.On("Close")} | |
| 141 | + | } | |
| 142 | + | ||
| 143 | + | func (_c *MockSource_Close_Call) Run(run func()) *MockSource_Close_Call { | |
| 144 | + | _c.Call.Run(func(args mock.Arguments) { | |
| 145 | + | run() | |
| 146 | + | }) | |
| 147 | + | return _c | |
| 148 | + | } | |
| 149 | + | ||
| 150 | + | func (_c *MockSource_Close_Call) Return(err error) *MockSource_Close_Call { | |
| 151 | + | _c.Call.Return(err) | |
| 152 | + | return _c | |
| 153 | + | } | |
| 154 | + | ||
| 155 | + | func (_c *MockSource_Close_Call) RunAndReturn(run func() error) *MockSource_Close_Call { | |
| 156 | + | _c.Call.Return(run) | |
| 157 | + | return _c | |
| 158 | + | } | |
| 159 | + | ||
| 160 | + | // Outputs provides a mock function for the type MockSource | |
| 161 | + | func (_mock *MockSource) Outputs(context1 context.Context) ([]ports.Output, error) { | |
| 162 | + | ret := _mock.Called(context1) | |
| 163 | + | ||
| 164 | + | if len(ret) == 0 { | |
| 165 | + | panic("no return value specified for Outputs") | |
| 166 | + | } | |
| 167 | + | ||
| 168 | + | var r0 []ports.Output | |
| 169 | + | var r1 error | |
| 170 | + | if returnFunc, ok := ret.Get(0).(func(context.Context) ([]ports.Output, error)); ok { | |
| 171 | + | return returnFunc(context1) | |
| 172 | + | } | |
| 173 | + | if returnFunc, ok := ret.Get(0).(func(context.Context) []ports.Output); ok { | |
| 174 | + | r0 = returnFunc(context1) | |
| 175 | + | } else { | |
| 176 | + | if ret.Get(0) != nil { | |
| 177 | + | r0 = ret.Get(0).([]ports.Output) | |
| 178 | + | } | |
| 179 | + | } | |
| 180 | + | if returnFunc, ok := ret.Get(1).(func(context.Context) error); ok { | |
| 181 | + | r1 = returnFunc(context1) | |
| 182 | + | } else { | |
| 183 | + | r1 = ret.Error(1) | |
| 184 | + | } | |
| 185 | + | return r0, r1 | |
| 186 | + | } | |
| 187 | + | ||
| 188 | + | // MockSource_Outputs_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'Outputs' | |
| 189 | + | type MockSource_Outputs_Call struct { | |
| 190 | + | *mock.Call | |
| 191 | + | } | |
| 192 | + | ||
| 193 | + | // Outputs is a helper method to define mock.On call | |
| 194 | + | // - context1 context.Context | |
| 195 | + | func (_e *MockSource_Expecter) Outputs(context1 any) *MockSource_Outputs_Call { | |
| 196 | + | return &MockSource_Outputs_Call{Call: _e.mock.On("Outputs", context1)} | |
| 197 | + | } | |
| 198 | + | ||
| 199 | + | func (_c *MockSource_Outputs_Call) Run(run func(context1 context.Context)) *MockSource_Outputs_Call { | |
| 200 | + | _c.Call.Run(func(args mock.Arguments) { | |
| 201 | + | var arg0 context.Context | |
| 202 | + | if args[0] != nil { | |
| 203 | + | arg0 = args[0].(context.Context) | |
| 204 | + | } | |
| 205 | + | run( | |
| 206 | + | arg0, | |
| 207 | + | ) | |
| 208 | + | }) | |
| 209 | + | return _c | |
| 210 | + | } | |
| 211 | + | ||
| 212 | + | func (_c *MockSource_Outputs_Call) Return(outputs []ports.Output, err error) *MockSource_Outputs_Call { | |
| 213 | + | _c.Call.Return(outputs, err) | |
| 214 | + | return _c | |
| 215 | + | } | |
| 216 | + | ||
| 217 | + | func (_c *MockSource_Outputs_Call) RunAndReturn(run func(context1 context.Context) ([]ports.Output, error)) *MockSource_Outputs_Call { | |
| 218 | + | _c.Call.Return(run) | |
| 219 | + | return _c | |
| 220 | + | } | |
| 221 | + | ||
| 222 | + | // NewMockScreenshotWriter creates a new instance of MockScreenshotWriter. It also registers a testing interface on the mock and a cleanup function to assert the mocks expectations. | |
| 223 | + | // The first argument is typically a *testing.T value. | |
| 224 | + | func NewMockScreenshotWriter(t interface { | |
| 225 | + | mock.TestingT | |
| 226 | + | Cleanup(func()) | |
| 227 | + | }) *MockScreenshotWriter { | |
| 228 | + | if helper, ok := t.(interface{ Helper() }); ok { | |
| 229 | + | helper.Helper() | |
| 230 | + | } | |
| 231 | + | ||
| 232 | + | mock := &MockScreenshotWriter{} | |
| 233 | + | mock.Mock.Test(t) | |
| 234 | + | ||
| 235 | + | t.Cleanup(func() { | |
| 236 | + | if helper, ok := t.(interface{ Helper() }); ok { | |
| 237 | + | helper.Helper() | |
| 238 | + | } | |
| 239 | + | mock.AssertExpectations(t) | |
| 240 | + | }) | |
| 241 | + | ||
| 242 | + | return mock | |
| 243 | + | } | |
| 244 | + | ||
| 245 | + | // MockScreenshotWriter is an autogenerated mock type for the ScreenshotWriter type | |
| 246 | + | type MockScreenshotWriter struct { | |
| 247 | + | mock.Mock | |
| 248 | + | } | |
| 249 | + | ||
| 250 | + | type MockScreenshotWriter_Expecter struct { | |
| 251 | + | mock *mock.Mock | |
| 252 | + | } | |
| 253 | + | ||
| 254 | + | func (_m *MockScreenshotWriter) EXPECT() *MockScreenshotWriter_Expecter { | |
| 255 | + | return &MockScreenshotWriter_Expecter{mock: &_m.Mock} | |
| 256 | + | } | |
| 257 | + | ||
| 258 | + | // Save provides a mock function for the type MockScreenshotWriter | |
| 259 | + | func (_mock *MockScreenshotWriter) Save(context1 context.Context, frame ports.Frame, s string) error { | |
| 260 | + | ret := _mock.Called(context1, frame, s) | |
| 261 | + | ||
| 262 | + | if len(ret) == 0 { | |
| 263 | + | panic("no return value specified for Save") | |
| 264 | + | } | |
| 265 | + | ||
| 266 | + | var r0 error | |
| 267 | + | if returnFunc, ok := ret.Get(0).(func(context.Context, ports.Frame, string) error); ok { | |
| 268 | + | r0 = returnFunc(context1, frame, s) | |
| 269 | + | } else { | |
| 270 | + | r0 = ret.Error(0) | |
| 271 | + | } | |
| 272 | + | return r0 | |
| 273 | + | } | |
| 274 | + | ||
| 275 | + | // MockScreenshotWriter_Save_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'Save' | |
| 276 | + | type MockScreenshotWriter_Save_Call struct { | |
| 277 | + | *mock.Call | |
| 278 | + | } | |
| 279 | + | ||
| 280 | + | // Save is a helper method to define mock.On call | |
| 281 | + | // - context1 context.Context | |
| 282 | + | // - frame ports.Frame | |
| 283 | + | // - s string | |
| 284 | + | func (_e *MockScreenshotWriter_Expecter) Save(context1 any, frame any, s any) *MockScreenshotWriter_Save_Call { | |
| 285 | + | return &MockScreenshotWriter_Save_Call{Call: _e.mock.On("Save", context1, frame, s)} | |
| 286 | + | } | |
| 287 | + | ||
| 288 | + | func (_c *MockScreenshotWriter_Save_Call) Run(run func(context1 context.Context, frame ports.Frame, s string)) *MockScreenshotWriter_Save_Call { | |
| 289 | + | _c.Call.Run(func(args mock.Arguments) { | |
| 290 | + | var arg0 context.Context | |
| 291 | + | if args[0] != nil { | |
| 292 | + | arg0 = args[0].(context.Context) | |
| 293 | + | } | |
| 294 | + | var arg1 ports.Frame | |
| 295 | + | if args[1] != nil { | |
| 296 | + | arg1 = args[1].(ports.Frame) | |
| 297 | + | } | |
| 298 | + | var arg2 string | |
| 299 | + | if args[2] != nil { | |
| 300 | + | arg2 = args[2].(string) | |
| 301 | + | } | |
| 302 | + | run( | |
| 303 | + | arg0, | |
| 304 | + | arg1, | |
| 305 | + | arg2, | |
| 306 | + | ) | |
| 307 | + | }) | |
| 308 | + | return _c | |
| 309 | + | } | |
| 310 | + | ||
| 311 | + | func (_c *MockScreenshotWriter_Save_Call) Return(err error) *MockScreenshotWriter_Save_Call { | |
| 312 | + | _c.Call.Return(err) | |
| 313 | + | return _c | |
| 314 | + | } | |
| 315 | + | ||
| 316 | + | func (_c *MockScreenshotWriter_Save_Call) RunAndReturn(run func(context1 context.Context, frame ports.Frame, s string) error) *MockScreenshotWriter_Save_Call { | |
| 317 | + | _c.Call.Return(run) | |
| 318 | + | return _c | |
| 319 | + | } | |
| 320 | + | ||
| 321 | + | // NewMockVideoWriter creates a new instance of MockVideoWriter. It also registers a testing interface on the mock and a cleanup function to assert the mocks expectations. | |
| 322 | + | // The first argument is typically a *testing.T value. | |
| 323 | + | func NewMockVideoWriter(t interface { | |
| 324 | + | mock.TestingT | |
| 325 | + | Cleanup(func()) | |
| 326 | + | }) *MockVideoWriter { | |
| 327 | + | if helper, ok := t.(interface{ Helper() }); ok { | |
| 328 | + | helper.Helper() | |
| 329 | + | } | |
| 330 | + | ||
| 331 | + | mock := &MockVideoWriter{} | |
| 332 | + | mock.Mock.Test(t) | |
| 333 | + | ||
| 334 | + | t.Cleanup(func() { | |
| 335 | + | if helper, ok := t.(interface{ Helper() }); ok { | |
| 336 | + | helper.Helper() | |
| 337 | + | } | |
| 338 | + | mock.AssertExpectations(t) | |
| 339 | + | }) | |
| 340 | + | ||
| 341 | + | return mock | |
| 342 | + | } | |
| 343 | + | ||
| 344 | + | // MockVideoWriter is an autogenerated mock type for the VideoWriter type | |
| 345 | + | type MockVideoWriter struct { | |
| 346 | + | mock.Mock | |
| 347 | + | } | |
| 348 | + | ||
| 349 | + | type MockVideoWriter_Expecter struct { | |
| 350 | + | mock *mock.Mock | |
| 351 | + | } | |
| 352 | + | ||
| 353 | + | func (_m *MockVideoWriter) EXPECT() *MockVideoWriter_Expecter { | |
| 354 | + | return &MockVideoWriter_Expecter{mock: &_m.Mock} | |
| 355 | + | } | |
| 356 | + | ||
| 357 | + | // Abort provides a mock function for the type MockVideoWriter | |
| 358 | + | func (_mock *MockVideoWriter) Abort() error { | |
| 359 | + | ret := _mock.Called() | |
| 360 | + | ||
| 361 | + | if len(ret) == 0 { | |
| 362 | + | panic("no return value specified for Abort") | |
| 363 | + | } | |
| 364 | + | ||
| 365 | + | var r0 error | |
| 366 | + | if returnFunc, ok := ret.Get(0).(func() error); ok { | |
| 367 | + | r0 = returnFunc() | |
| 368 | + | } else { | |
| 369 | + | r0 = ret.Error(0) | |
| 370 | + | } | |
| 371 | + | return r0 | |
| 372 | + | } | |
| 373 | + | ||
| 374 | + | // MockVideoWriter_Abort_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'Abort' | |
| 375 | + | type MockVideoWriter_Abort_Call struct { | |
| 376 | + | *mock.Call | |
| 377 | + | } | |
| 378 | + | ||
| 379 | + | // Abort is a helper method to define mock.On call | |
| 380 | + | func (_e *MockVideoWriter_Expecter) Abort() *MockVideoWriter_Abort_Call { | |
| 381 | + | return &MockVideoWriter_Abort_Call{Call: _e.mock.On("Abort")} | |
| 382 | + | } | |
| 383 | + | ||
| 384 | + | func (_c *MockVideoWriter_Abort_Call) Run(run func()) *MockVideoWriter_Abort_Call { | |
| 385 | + | _c.Call.Run(func(args mock.Arguments) { | |
| 386 | + | run() | |
| 387 | + | }) | |
| 388 | + | return _c | |
| 389 | + | } | |
| 390 | + | ||
| 391 | + | func (_c *MockVideoWriter_Abort_Call) Return(err error) *MockVideoWriter_Abort_Call { | |
| 392 | + | _c.Call.Return(err) | |
| 393 | + | return _c | |
| 394 | + | } | |
| 395 | + | ||
| 396 | + | func (_c *MockVideoWriter_Abort_Call) RunAndReturn(run func() error) *MockVideoWriter_Abort_Call { | |
| 397 | + | _c.Call.Return(run) | |
| 398 | + | return _c | |
| 399 | + | } | |
| 400 | + | ||
| 401 | + | // Close provides a mock function for the type MockVideoWriter | |
| 402 | + | func (_mock *MockVideoWriter) Close() error { | |
| 403 | + | ret := _mock.Called() | |
| 404 | + | ||
| 405 | + | if len(ret) == 0 { | |
| 406 | + | panic("no return value specified for Close") | |
| 407 | + | } | |
| 408 | + | ||
| 409 | + | var r0 error | |
| 410 | + | if returnFunc, ok := ret.Get(0).(func() error); ok { | |
| 411 | + | r0 = returnFunc() | |
| 412 | + | } else { | |
| 413 | + | r0 = ret.Error(0) | |
| 414 | + | } | |
| 415 | + | return r0 | |
| 416 | + | } | |
| 417 | + | ||
| 418 | + | // MockVideoWriter_Close_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'Close' | |
| 419 | + | type MockVideoWriter_Close_Call struct { | |
| 420 | + | *mock.Call | |
| 421 | + | } | |
| 422 | + | ||
| 423 | + | // Close is a helper method to define mock.On call | |
| 424 | + | func (_e *MockVideoWriter_Expecter) Close() *MockVideoWriter_Close_Call { | |
| 425 | + | return &MockVideoWriter_Close_Call{Call: _e.mock.On("Close")} | |
| 426 | + | } | |
| 427 | + | ||
| 428 | + | func (_c *MockVideoWriter_Close_Call) Run(run func()) *MockVideoWriter_Close_Call { | |
| 429 | + | _c.Call.Run(func(args mock.Arguments) { | |
| 430 | + | run() | |
| 431 | + | }) | |
| 432 | + | return _c | |
| 433 | + | } | |
| 434 | + | ||
| 435 | + | func (_c *MockVideoWriter_Close_Call) Return(err error) *MockVideoWriter_Close_Call { | |
| 436 | + | _c.Call.Return(err) | |
| 437 | + | return _c | |
| 438 | + | } | |
| 439 | + | ||
| 440 | + | func (_c *MockVideoWriter_Close_Call) RunAndReturn(run func() error) *MockVideoWriter_Close_Call { | |
| 441 | + | _c.Call.Return(run) | |
| 442 | + | return _c | |
| 443 | + | } | |
| 444 | + | ||
| 445 | + | // Start provides a mock function for the type MockVideoWriter | |
| 446 | + | func (_mock *MockVideoWriter) Start(context1 context.Context, frame ports.Frame, s string, videoSettings ports.VideoSettings) error { | |
| 447 | + | ret := _mock.Called(context1, frame, s, videoSettings) | |
| 448 | + | ||
| 449 | + | if len(ret) == 0 { | |
| 450 | + | panic("no return value specified for Start") | |
| 451 | + | } | |
| 452 | + | ||
| 453 | + | var r0 error | |
| 454 | + | if returnFunc, ok := ret.Get(0).(func(context.Context, ports.Frame, string, ports.VideoSettings) error); ok { | |
| 455 | + | r0 = returnFunc(context1, frame, s, videoSettings) | |
| 456 | + | } else { | |
| 457 | + | r0 = ret.Error(0) | |
| 458 | + | } | |
| 459 | + | return r0 | |
| 460 | + | } | |
| 461 | + | ||
| 462 | + | // MockVideoWriter_Start_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'Start' | |
| 463 | + | type MockVideoWriter_Start_Call struct { | |
| 464 | + | *mock.Call | |
| 465 | + | } | |
| 466 | + | ||
| 467 | + | // Start is a helper method to define mock.On call | |
| 468 | + | // - context1 context.Context | |
| 469 | + | // - frame ports.Frame | |
| 470 | + | // - s string | |
| 471 | + | // - videoSettings ports.VideoSettings | |
| 472 | + | func (_e *MockVideoWriter_Expecter) Start(context1 any, frame any, s any, videoSettings any) *MockVideoWriter_Start_Call { | |
| 473 | + | return &MockVideoWriter_Start_Call{Call: _e.mock.On("Start", context1, frame, s, videoSettings)} | |
| 474 | + | } | |
| 475 | + | ||
| 476 | + | func (_c *MockVideoWriter_Start_Call) Run(run func(context1 context.Context, frame ports.Frame, s string, videoSettings ports.VideoSettings)) *MockVideoWriter_Start_Call { | |
| 477 | + | _c.Call.Run(func(args mock.Arguments) { | |
| 478 | + | var arg0 context.Context | |
| 479 | + | if args[0] != nil { | |
| 480 | + | arg0 = args[0].(context.Context) | |
| 481 | + | } | |
| 482 | + | var arg1 ports.Frame | |
| 483 | + | if args[1] != nil { | |
| 484 | + | arg1 = args[1].(ports.Frame) | |
| 485 | + | } | |
| 486 | + | var arg2 string | |
| 487 | + | if args[2] != nil { | |
| 488 | + | arg2 = args[2].(string) | |
| 489 | + | } | |
| 490 | + | var arg3 ports.VideoSettings | |
| 491 | + | if args[3] != nil { | |
| 492 | + | arg3 = args[3].(ports.VideoSettings) | |
| 493 | + | } | |
| 494 | + | run( | |
| 495 | + | arg0, | |
| 496 | + | arg1, | |
| 497 | + | arg2, | |
| 498 | + | arg3, | |
| 499 | + | ) | |
| 500 | + | }) | |
| 501 | + | return _c | |
| 502 | + | } | |
| 503 | + | ||
| 504 | + | func (_c *MockVideoWriter_Start_Call) Return(err error) *MockVideoWriter_Start_Call { | |
| 505 | + | _c.Call.Return(err) | |
| 506 | + | return _c | |
| 507 | + | } | |
| 508 | + | ||
| 509 | + | func (_c *MockVideoWriter_Start_Call) RunAndReturn(run func(context1 context.Context, frame ports.Frame, s string, videoSettings ports.VideoSettings) error) *MockVideoWriter_Start_Call { | |
| 510 | + | _c.Call.Return(run) | |
| 511 | + | return _c | |
| 512 | + | } | |
| 513 | + | ||
| 514 | + | // Write provides a mock function for the type MockVideoWriter | |
| 515 | + | func (_mock *MockVideoWriter) Write(context1 context.Context, frame ports.Frame) error { | |
| 516 | + | ret := _mock.Called(context1, frame) | |
| 517 | + | ||
| 518 | + | if len(ret) == 0 { | |
| 519 | + | panic("no return value specified for Write") | |
| 520 | + | } | |
| 521 | + | ||
| 522 | + | var r0 error | |
| 523 | + | if returnFunc, ok := ret.Get(0).(func(context.Context, ports.Frame) error); ok { | |
| 524 | + | r0 = returnFunc(context1, frame) | |
| 525 | + | } else { | |
| 526 | + | r0 = ret.Error(0) | |
| 527 | + | } | |
| 528 | + | return r0 | |
| 529 | + | } | |
| 530 | + | ||
| 531 | + | // MockVideoWriter_Write_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'Write' | |
| 532 | + | type MockVideoWriter_Write_Call struct { | |
| 533 | + | *mock.Call | |
| 534 | + | } | |
| 535 | + | ||
| 536 | + | // Write is a helper method to define mock.On call | |
| 537 | + | // - context1 context.Context | |
| 538 | + | // - frame ports.Frame | |
| 539 | + | func (_e *MockVideoWriter_Expecter) Write(context1 any, frame any) *MockVideoWriter_Write_Call { | |
| 540 | + | return &MockVideoWriter_Write_Call{Call: _e.mock.On("Write", context1, frame)} | |
| 541 | + | } | |
| 542 | + | ||
| 543 | + | func (_c *MockVideoWriter_Write_Call) Run(run func(context1 context.Context, frame ports.Frame)) *MockVideoWriter_Write_Call { | |
| 544 | + | _c.Call.Run(func(args mock.Arguments) { | |
| 545 | + | var arg0 context.Context | |
| 546 | + | if args[0] != nil { | |
| 547 | + | arg0 = args[0].(context.Context) | |
| 548 | + | } | |
| 549 | + | var arg1 ports.Frame | |
| 550 | + | if args[1] != nil { | |
| 551 | + | arg1 = args[1].(ports.Frame) | |
| 552 | + | } | |
| 553 | + | run( | |
| 554 | + | arg0, | |
| 555 | + | arg1, | |
| 556 | + | ) | |
| 557 | + | }) | |
| 558 | + | return _c | |
| 559 | + | } | |
| 560 | + | ||
| 561 | + | func (_c *MockVideoWriter_Write_Call) Return(err error) *MockVideoWriter_Write_Call { | |
| 562 | + | _c.Call.Return(err) | |
| 563 | + | return _c | |
| 564 | + | } | |
| 565 | + | ||
| 566 | + | func (_c *MockVideoWriter_Write_Call) RunAndReturn(run func(context1 context.Context, frame ports.Frame) error) *MockVideoWriter_Write_Call { | |
| 567 | + | _c.Call.Return(run) | |
| 568 | + | return _c | |
| 569 | + | } | |
| 570 | + | ||
| 571 | + | // NewMockSelector creates a new instance of MockSelector. It also registers a testing interface on the mock and a cleanup function to assert the mocks expectations. | |
| 572 | + | // The first argument is typically a *testing.T value. | |
| 573 | + | func NewMockSelector(t interface { | |
| 574 | + | mock.TestingT | |
| 575 | + | Cleanup(func()) | |
| 576 | + | }) *MockSelector { | |
| 577 | + | if helper, ok := t.(interface{ Helper() }); ok { | |
| 578 | + | helper.Helper() | |
| 579 | + | } | |
| 580 | + | ||
| 581 | + | mock := &MockSelector{} | |
| 582 | + | mock.Mock.Test(t) | |
| 583 | + | ||
| 584 | + | t.Cleanup(func() { | |
| 585 | + | if helper, ok := t.(interface{ Helper() }); ok { | |
| 586 | + | helper.Helper() | |
| 587 | + | } | |
| 588 | + | mock.AssertExpectations(t) | |
| 589 | + | }) | |
| 590 | + | ||
| 591 | + | return mock | |
| 592 | + | } | |
| 593 | + | ||
| 594 | + | // MockSelector is an autogenerated mock type for the Selector type | |
| 595 | + | type MockSelector struct { | |
| 596 | + | mock.Mock | |
| 597 | + | } | |
| 598 | + | ||
| 599 | + | type MockSelector_Expecter struct { | |
| 600 | + | mock *mock.Mock | |
| 601 | + | } | |
| 602 | + | ||
| 603 | + | func (_m *MockSelector) EXPECT() *MockSelector_Expecter { | |
| 604 | + | return &MockSelector_Expecter{mock: &_m.Mock} | |
| 605 | + | } | |
| 606 | + | ||
| 607 | + | // Select provides a mock function for the type MockSelector | |
| 608 | + | func (_mock *MockSelector) Select(context1 context.Context, outputs []ports.Output) (ports.Selection, bool, error) { | |
| 609 | + | ret := _mock.Called(context1, outputs) | |
| 610 | + | ||
| 611 | + | if len(ret) == 0 { | |
| 612 | + | panic("no return value specified for Select") | |
| 613 | + | } | |
| 614 | + | ||
| 615 | + | var r0 ports.Selection | |
| 616 | + | var r1 bool | |
| 617 | + | var r2 error | |
| 618 | + | if returnFunc, ok := ret.Get(0).(func(context.Context, []ports.Output) (ports.Selection, bool, error)); ok { | |
| 619 | + | return returnFunc(context1, outputs) | |
| 620 | + | } | |
| 621 | + | if returnFunc, ok := ret.Get(0).(func(context.Context, []ports.Output) ports.Selection); ok { | |
| 622 | + | r0 = returnFunc(context1, outputs) | |
| 623 | + | } else { | |
| 624 | + | r0 = ret.Get(0).(ports.Selection) | |
| 625 | + | } | |
| 626 | + | if returnFunc, ok := ret.Get(1).(func(context.Context, []ports.Output) bool); ok { | |
| 627 | + | r1 = returnFunc(context1, outputs) | |
| 628 | + | } else { | |
| 629 | + | r1 = ret.Get(1).(bool) | |
| 630 | + | } | |
| 631 | + | if returnFunc, ok := ret.Get(2).(func(context.Context, []ports.Output) error); ok { | |
| 632 | + | r2 = returnFunc(context1, outputs) | |
| 633 | + | } else { | |
| 634 | + | r2 = ret.Error(2) | |
| 635 | + | } | |
| 636 | + | return r0, r1, r2 | |
| 637 | + | } | |
| 638 | + | ||
| 639 | + | // MockSelector_Select_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'Select' | |
| 640 | + | type MockSelector_Select_Call struct { | |
| 641 | + | *mock.Call | |
| 642 | + | } | |
| 643 | + | ||
| 644 | + | // Select is a helper method to define mock.On call | |
| 645 | + | // - context1 context.Context | |
| 646 | + | // - outputs []ports.Output | |
| 647 | + | func (_e *MockSelector_Expecter) Select(context1 any, outputs any) *MockSelector_Select_Call { | |
| 648 | + | return &MockSelector_Select_Call{Call: _e.mock.On("Select", context1, outputs)} | |
| 649 | + | } | |
| 650 | + | ||
| 651 | + | func (_c *MockSelector_Select_Call) Run(run func(context1 context.Context, outputs []ports.Output)) *MockSelector_Select_Call { | |
| 652 | + | _c.Call.Run(func(args mock.Arguments) { | |
| 653 | + | var arg0 context.Context | |
| 654 | + | if args[0] != nil { | |
| 655 | + | arg0 = args[0].(context.Context) | |
| 656 | + | } | |
| 657 | + | var arg1 []ports.Output | |
| 658 | + | if args[1] != nil { | |
| 659 | + | arg1 = args[1].([]ports.Output) | |
| 660 | + | } | |
| 661 | + | run( | |
| 662 | + | arg0, | |
| 663 | + | arg1, | |
| 664 | + | ) | |
| 665 | + | }) | |
| 666 | + | return _c | |
| 667 | + | } | |
| 668 | + | ||
| 669 | + | func (_c *MockSelector_Select_Call) Return(selection ports.Selection, b bool, err error) *MockSelector_Select_Call { | |
| 670 | + | _c.Call.Return(selection, b, err) | |
| 671 | + | return _c | |
| 672 | + | } | |
| 673 | + | ||
| 674 | + | func (_c *MockSelector_Select_Call) RunAndReturn(run func(context1 context.Context, outputs []ports.Output) (ports.Selection, bool, error)) *MockSelector_Select_Call { | |
| 675 | + | _c.Call.Return(run) | |
| 676 | + | return _c | |
| 677 | + | } | |
| @@ -0,0 +1,677 @@ | |||||
| 1 | + | // Code generated by mockery; DO NOT EDIT. | |||
| 2 | + | // github.com/vektra/mockery | |||
| 3 | + | // template: testify | |||
| 4 | + | ||||
| 5 | + | package portsmocks | |||
| 6 | + | ||||
| 7 | + | import ( | |||
| 8 | + | "context" | |||
| 9 | + | ||||
| 10 | + | "github.com/bnema/nefercap/internal/ports" | |||
| 11 | + | mock "github.com/stretchr/testify/mock" | |||
| 12 | + | ) | |||
| 13 | + | ||||
| 14 | + | // NewMockSource creates a new instance of MockSource. It also registers a testing interface on the mock and a cleanup function to assert the mocks expectations. | |||
| 15 | + | // The first argument is typically a *testing.T value. | |||
| 16 | + | func NewMockSource(t interface { | |||
| 17 | + | mock.TestingT | |||
| 18 | + | Cleanup(func()) | |||
| 19 | + | }) *MockSource { | |||
| 20 | + | if helper, ok := t.(interface{ Helper() }); ok { | |||
| 21 | + | helper.Helper() | |||
| 22 | + | } | |||
| 23 | + | ||||
| 24 | + | mock := &MockSource{} | |||
| 25 | + | mock.Mock.Test(t) | |||
| 26 | + | ||||
| 27 | + | t.Cleanup(func() { | |||
| 28 | + | if helper, ok := t.(interface{ Helper() }); ok { | |||
| 29 | + | helper.Helper() | |||
| 30 | + | } | |||
| 31 | + | mock.AssertExpectations(t) | |||
| 32 | + | }) | |||
| 33 | + | ||||
| 34 | + | return mock | |||
| 35 | + | } | |||
| 36 | + | ||||
| 37 | + | // MockSource is an autogenerated mock type for the Source type | |||
| 38 | + | type MockSource struct { | |||
| 39 | + | mock.Mock | |||
| 40 | + | } | |||
| 41 | + | ||||
| 42 | + | type MockSource_Expecter struct { | |||
| 43 | + | mock *mock.Mock | |||
| 44 | + | } | |||
| 45 | + | ||||
| 46 | + | func (_m *MockSource) EXPECT() *MockSource_Expecter { | |||
| 47 | + | return &MockSource_Expecter{mock: &_m.Mock} | |||
| 48 | + | } | |||
| 49 | + | ||||
| 50 | + | // Capture provides a mock function for the type MockSource | |||
| 51 | + | func (_mock *MockSource) Capture(context1 context.Context, target ports.Target) (ports.Frame, error) { | |||
| 52 | + | ret := _mock.Called(context1, target) | |||
| 53 | + | ||||
| 54 | + | if len(ret) == 0 { | |||
| 55 | + | panic("no return value specified for Capture") | |||
| 56 | + | } | |||
| 57 | + | ||||
| 58 | + | var r0 ports.Frame | |||
| 59 | + | var r1 error | |||
| 60 | + | if returnFunc, ok := ret.Get(0).(func(context.Context, ports.Target) (ports.Frame, error)); ok { | |||
| 61 | + | return returnFunc(context1, target) | |||
| 62 | + | } | |||
| 63 | + | if returnFunc, ok := ret.Get(0).(func(context.Context, ports.Target) ports.Frame); ok { | |||
| 64 | + | r0 = returnFunc(context1, target) | |||
| 65 | + | } else { | |||
| 66 | + | r0 = ret.Get(0).(ports.Frame) | |||
| 67 | + | } | |||
| 68 | + | if returnFunc, ok := ret.Get(1).(func(context.Context, ports.Target) error); ok { | |||
| 69 | + | r1 = returnFunc(context1, target) | |||
| 70 | + | } else { | |||
| 71 | + | r1 = ret.Error(1) | |||
| 72 | + | } | |||
| 73 | + | return r0, r1 | |||
| 74 | + | } | |||
| 75 | + | ||||
| 76 | + | // MockSource_Capture_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'Capture' | |||
| 77 | + | type MockSource_Capture_Call struct { | |||
| 78 | + | *mock.Call | |||
| 79 | + | } | |||
| 80 | + | ||||
| 81 | + | // Capture is a helper method to define mock.On call | |||
| 82 | + | // - context1 context.Context | |||
| 83 | + | // - target ports.Target | |||
| 84 | + | func (_e *MockSource_Expecter) Capture(context1 any, target any) *MockSource_Capture_Call { | |||
| 85 | + | return &MockSource_Capture_Call{Call: _e.mock.On("Capture", context1, target)} | |||
| 86 | + | } | |||
| 87 | + | ||||
| 88 | + | func (_c *MockSource_Capture_Call) Run(run func(context1 context.Context, target ports.Target)) *MockSource_Capture_Call { | |||
| 89 | + | _c.Call.Run(func(args mock.Arguments) { | |||
| 90 | + | var arg0 context.Context | |||
| 91 | + | if args[0] != nil { | |||
| 92 | + | arg0 = args[0].(context.Context) | |||
| 93 | + | } | |||
| 94 | + | var arg1 ports.Target | |||
| 95 | + | if args[1] != nil { | |||
| 96 | + | arg1 = args[1].(ports.Target) | |||
| 97 | + | } | |||
| 98 | + | run( | |||
| 99 | + | arg0, | |||
| 100 | + | arg1, | |||
| 101 | + | ) | |||
| 102 | + | }) | |||
| 103 | + | return _c | |||
| 104 | + | } | |||
| 105 | + | ||||
| 106 | + | func (_c *MockSource_Capture_Call) Return(frame ports.Frame, err error) *MockSource_Capture_Call { | |||
| 107 | + | _c.Call.Return(frame, err) | |||
| 108 | + | return _c | |||
| 109 | + | } | |||
| 110 | + | ||||
| 111 | + | func (_c *MockSource_Capture_Call) RunAndReturn(run func(context1 context.Context, target ports.Target) (ports.Frame, error)) *MockSource_Capture_Call { | |||
| 112 | + | _c.Call.Return(run) | |||
| 113 | + | return _c | |||
| 114 | + | } | |||
| 115 | + | ||||
| 116 | + | // Close provides a mock function for the type MockSource | |||
| 117 | + | func (_mock *MockSource) Close() error { | |||
| 118 | + | ret := _mock.Called() | |||
| 119 | + | ||||
| 120 | + | if len(ret) == 0 { | |||
| 121 | + | panic("no return value specified for Close") | |||
| 122 | + | } | |||
| 123 | + | ||||
| 124 | + | var r0 error | |||
| 125 | + | if returnFunc, ok := ret.Get(0).(func() error); ok { | |||
| 126 | + | r0 = returnFunc() | |||
| 127 | + | } else { | |||
| 128 | + | r0 = ret.Error(0) | |||
| 129 | + | } | |||
| 130 | + | return r0 | |||
| 131 | + | } | |||
| 132 | + | ||||
| 133 | + | // MockSource_Close_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'Close' | |||
| 134 | + | type MockSource_Close_Call struct { | |||
| 135 | + | *mock.Call | |||
| 136 | + | } | |||
| 137 | + | ||||
| 138 | + | // Close is a helper method to define mock.On call | |||
| 139 | + | func (_e *MockSource_Expecter) Close() *MockSource_Close_Call { | |||
| 140 | + | return &MockSource_Close_Call{Call: _e.mock.On("Close")} | |||
| 141 | + | } | |||
| 142 | + | ||||
| 143 | + | func (_c *MockSource_Close_Call) Run(run func()) *MockSource_Close_Call { | |||
| 144 | + | _c.Call.Run(func(args mock.Arguments) { | |||
| 145 | + | run() | |||
| 146 | + | }) | |||
| 147 | + | return _c | |||
| 148 | + | } | |||
| 149 | + | ||||
| 150 | + | func (_c *MockSource_Close_Call) Return(err error) *MockSource_Close_Call { | |||
| 151 | + | _c.Call.Return(err) | |||
| 152 | + | return _c | |||
| 153 | + | } | |||
| 154 | + | ||||
| 155 | + | func (_c *MockSource_Close_Call) RunAndReturn(run func() error) *MockSource_Close_Call { | |||
| 156 | + | _c.Call.Return(run) | |||
| 157 | + | return _c | |||
| 158 | + | } | |||
| 159 | + | ||||
| 160 | + | // Outputs provides a mock function for the type MockSource | |||
| 161 | + | func (_mock *MockSource) Outputs(context1 context.Context) ([]ports.Output, error) { | |||
| 162 | + | ret := _mock.Called(context1) | |||
| 163 | + | ||||
| 164 | + | if len(ret) == 0 { | |||
| 165 | + | panic("no return value specified for Outputs") | |||
| 166 | + | } | |||
| 167 | + | ||||
| 168 | + | var r0 []ports.Output | |||
| 169 | + | var r1 error | |||
| 170 | + | if returnFunc, ok := ret.Get(0).(func(context.Context) ([]ports.Output, error)); ok { | |||
| 171 | + | return returnFunc(context1) | |||
| 172 | + | } | |||
| 173 | + | if returnFunc, ok := ret.Get(0).(func(context.Context) []ports.Output); ok { | |||
| 174 | + | r0 = returnFunc(context1) | |||
| 175 | + | } else { | |||
| 176 | + | if ret.Get(0) != nil { | |||
| 177 | + | r0 = ret.Get(0).([]ports.Output) | |||
| 178 | + | } | |||
| 179 | + | } | |||
| 180 | + | if returnFunc, ok := ret.Get(1).(func(context.Context) error); ok { | |||
| 181 | + | r1 = returnFunc(context1) | |||
| 182 | + | } else { | |||
| 183 | + | r1 = ret.Error(1) | |||
| 184 | + | } | |||
| 185 | + | return r0, r1 | |||
| 186 | + | } | |||
| 187 | + | ||||
| 188 | + | // MockSource_Outputs_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'Outputs' | |||
| 189 | + | type MockSource_Outputs_Call struct { | |||
| 190 | + | *mock.Call | |||
| 191 | + | } | |||
| 192 | + | ||||
| 193 | + | // Outputs is a helper method to define mock.On call | |||
| 194 | + | // - context1 context.Context | |||
| 195 | + | func (_e *MockSource_Expecter) Outputs(context1 any) *MockSource_Outputs_Call { | |||
| 196 | + | return &MockSource_Outputs_Call{Call: _e.mock.On("Outputs", context1)} | |||
| 197 | + | } | |||
| 198 | + | ||||
| 199 | + | func (_c *MockSource_Outputs_Call) Run(run func(context1 context.Context)) *MockSource_Outputs_Call { | |||
| 200 | + | _c.Call.Run(func(args mock.Arguments) { | |||
| 201 | + | var arg0 context.Context | |||
| 202 | + | if args[0] != nil { | |||
| 203 | + | arg0 = args[0].(context.Context) | |||
| 204 | + | } | |||
| 205 | + | run( | |||
| 206 | + | arg0, | |||
| 207 | + | ) | |||
| 208 | + | }) | |||
| 209 | + | return _c | |||
| 210 | + | } | |||
| 211 | + | ||||
| 212 | + | func (_c *MockSource_Outputs_Call) Return(outputs []ports.Output, err error) *MockSource_Outputs_Call { | |||
| 213 | + | _c.Call.Return(outputs, err) | |||
| 214 | + | return _c | |||
| 215 | + | } | |||
| 216 | + | ||||
| 217 | + | func (_c *MockSource_Outputs_Call) RunAndReturn(run func(context1 context.Context) ([]ports.Output, error)) *MockSource_Outputs_Call { | |||
| 218 | + | _c.Call.Return(run) | |||
| 219 | + | return _c | |||
| 220 | + | } | |||
| 221 | + | ||||
| 222 | + | // NewMockScreenshotWriter creates a new instance of MockScreenshotWriter. It also registers a testing interface on the mock and a cleanup function to assert the mocks expectations. | |||
| 223 | + | // The first argument is typically a *testing.T value. | |||
| 224 | + | func NewMockScreenshotWriter(t interface { | |||
| 225 | + | mock.TestingT | |||
| 226 | + | Cleanup(func()) | |||
| 227 | + | }) *MockScreenshotWriter { | |||
| 228 | + | if helper, ok := t.(interface{ Helper() }); ok { | |||
| 229 | + | helper.Helper() | |||
| 230 | + | } | |||
| 231 | + | ||||
| 232 | + | mock := &MockScreenshotWriter{} | |||
| 233 | + | mock.Mock.Test(t) | |||
| 234 | + | ||||
| 235 | + | t.Cleanup(func() { | |||
| 236 | + | if helper, ok := t.(interface{ Helper() }); ok { | |||
| 237 | + | helper.Helper() | |||
| 238 | + | } | |||
| 239 | + | mock.AssertExpectations(t) | |||
| 240 | + | }) | |||
| 241 | + | ||||
| 242 | + | return mock | |||
| 243 | + | } | |||
| 244 | + | ||||
| 245 | + | // MockScreenshotWriter is an autogenerated mock type for the ScreenshotWriter type | |||
| 246 | + | type MockScreenshotWriter struct { | |||
| 247 | + | mock.Mock | |||
| 248 | + | } | |||
| 249 | + | ||||
| 250 | + | type MockScreenshotWriter_Expecter struct { | |||
| 251 | + | mock *mock.Mock | |||
| 252 | + | } | |||
| 253 | + | ||||
| 254 | + | func (_m *MockScreenshotWriter) EXPECT() *MockScreenshotWriter_Expecter { | |||
| 255 | + | return &MockScreenshotWriter_Expecter{mock: &_m.Mock} | |||
| 256 | + | } | |||
| 257 | + | ||||
| 258 | + | // Save provides a mock function for the type MockScreenshotWriter | |||
| 259 | + | func (_mock *MockScreenshotWriter) Save(context1 context.Context, frame ports.Frame, s string) error { | |||
| 260 | + | ret := _mock.Called(context1, frame, s) | |||
| 261 | + | ||||
| 262 | + | if len(ret) == 0 { | |||
| 263 | + | panic("no return value specified for Save") | |||
| 264 | + | } | |||
| 265 | + | ||||
| 266 | + | var r0 error | |||
| 267 | + | if returnFunc, ok := ret.Get(0).(func(context.Context, ports.Frame, string) error); ok { | |||
| 268 | + | r0 = returnFunc(context1, frame, s) | |||
| 269 | + | } else { | |||
| 270 | + | r0 = ret.Error(0) | |||
| 271 | + | } | |||
| 272 | + | return r0 | |||
| 273 | + | } | |||
| 274 | + | ||||
| 275 | + | // MockScreenshotWriter_Save_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'Save' | |||
| 276 | + | type MockScreenshotWriter_Save_Call struct { | |||
| 277 | + | *mock.Call | |||
| 278 | + | } | |||
| 279 | + | ||||
| 280 | + | // Save is a helper method to define mock.On call | |||
| 281 | + | // - context1 context.Context | |||
| 282 | + | // - frame ports.Frame | |||
| 283 | + | // - s string | |||
| 284 | + | func (_e *MockScreenshotWriter_Expecter) Save(context1 any, frame any, s any) *MockScreenshotWriter_Save_Call { | |||
| 285 | + | return &MockScreenshotWriter_Save_Call{Call: _e.mock.On("Save", context1, frame, s)} | |||
| 286 | + | } | |||
| 287 | + | ||||
| 288 | + | func (_c *MockScreenshotWriter_Save_Call) Run(run func(context1 context.Context, frame ports.Frame, s string)) *MockScreenshotWriter_Save_Call { | |||
| 289 | + | _c.Call.Run(func(args mock.Arguments) { | |||
| 290 | + | var arg0 context.Context | |||
| 291 | + | if args[0] != nil { | |||
| 292 | + | arg0 = args[0].(context.Context) | |||
| 293 | + | } | |||
| 294 | + | var arg1 ports.Frame | |||
| 295 | + | if args[1] != nil { | |||
| 296 | + | arg1 = args[1].(ports.Frame) | |||
| 297 | + | } | |||
| 298 | + | var arg2 string | |||
| 299 | + | if args[2] != nil { | |||
| 300 | + | arg2 = args[2].(string) | |||
| 301 | + | } | |||
| 302 | + | run( | |||
| 303 | + | arg0, | |||
| 304 | + | arg1, | |||
| 305 | + | arg2, | |||
| 306 | + | ) | |||
| 307 | + | }) | |||
| 308 | + | return _c | |||
| 309 | + | } | |||
| 310 | + | ||||
| 311 | + | func (_c *MockScreenshotWriter_Save_Call) Return(err error) *MockScreenshotWriter_Save_Call { | |||
| 312 | + | _c.Call.Return(err) | |||
| 313 | + | return _c | |||
| 314 | + | } | |||
| 315 | + | ||||
| 316 | + | func (_c *MockScreenshotWriter_Save_Call) RunAndReturn(run func(context1 context.Context, frame ports.Frame, s string) error) *MockScreenshotWriter_Save_Call { | |||
| 317 | + | _c.Call.Return(run) | |||
| 318 | + | return _c | |||
| 319 | + | } | |||
| 320 | + | ||||
| 321 | + | // NewMockVideoWriter creates a new instance of MockVideoWriter. It also registers a testing interface on the mock and a cleanup function to assert the mocks expectations. | |||
| 322 | + | // The first argument is typically a *testing.T value. | |||
| 323 | + | func NewMockVideoWriter(t interface { | |||
| 324 | + | mock.TestingT | |||
| 325 | + | Cleanup(func()) | |||
| 326 | + | }) *MockVideoWriter { | |||
| 327 | + | if helper, ok := t.(interface{ Helper() }); ok { | |||
| 328 | + | helper.Helper() | |||
| 329 | + | } | |||
| 330 | + | ||||
| 331 | + | mock := &MockVideoWriter{} | |||
| 332 | + | mock.Mock.Test(t) | |||
| 333 | + | ||||
| 334 | + | t.Cleanup(func() { | |||
| 335 | + | if helper, ok := t.(interface{ Helper() }); ok { | |||
| 336 | + | helper.Helper() | |||
| 337 | + | } | |||
| 338 | + | mock.AssertExpectations(t) | |||
| 339 | + | }) | |||
| 340 | + | ||||
| 341 | + | return mock | |||
| 342 | + | } | |||
| 343 | + | ||||
| 344 | + | // MockVideoWriter is an autogenerated mock type for the VideoWriter type | |||
| 345 | + | type MockVideoWriter struct { | |||
| 346 | + | mock.Mock | |||
| 347 | + | } | |||
| 348 | + | ||||
| 349 | + | type MockVideoWriter_Expecter struct { | |||
| 350 | + | mock *mock.Mock | |||
| 351 | + | } | |||
| 352 | + | ||||
| 353 | + | func (_m *MockVideoWriter) EXPECT() *MockVideoWriter_Expecter { | |||
| 354 | + | return &MockVideoWriter_Expecter{mock: &_m.Mock} | |||
| 355 | + | } | |||
| 356 | + | ||||
| 357 | + | // Abort provides a mock function for the type MockVideoWriter | |||
| 358 | + | func (_mock *MockVideoWriter) Abort() error { | |||
| 359 | + | ret := _mock.Called() | |||
| 360 | + | ||||
| 361 | + | if len(ret) == 0 { | |||
| 362 | + | panic("no return value specified for Abort") | |||
| 363 | + | } | |||
| 364 | + | ||||
| 365 | + | var r0 error | |||
| 366 | + | if returnFunc, ok := ret.Get(0).(func() error); ok { | |||
| 367 | + | r0 = returnFunc() | |||
| 368 | + | } else { | |||
| 369 | + | r0 = ret.Error(0) | |||
| 370 | + | } | |||
| 371 | + | return r0 | |||
| 372 | + | } | |||
| 373 | + | ||||
| 374 | + | // MockVideoWriter_Abort_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'Abort' | |||
| 375 | + | type MockVideoWriter_Abort_Call struct { | |||
| 376 | + | *mock.Call | |||
| 377 | + | } | |||
| 378 | + | ||||
| 379 | + | // Abort is a helper method to define mock.On call | |||
| 380 | + | func (_e *MockVideoWriter_Expecter) Abort() *MockVideoWriter_Abort_Call { | |||
| 381 | + | return &MockVideoWriter_Abort_Call{Call: _e.mock.On("Abort")} | |||
| 382 | + | } | |||
| 383 | + | ||||
| 384 | + | func (_c *MockVideoWriter_Abort_Call) Run(run func()) *MockVideoWriter_Abort_Call { | |||
| 385 | + | _c.Call.Run(func(args mock.Arguments) { | |||
| 386 | + | run() | |||
| 387 | + | }) | |||
| 388 | + | return _c | |||
| 389 | + | } | |||
| 390 | + | ||||
| 391 | + | func (_c *MockVideoWriter_Abort_Call) Return(err error) *MockVideoWriter_Abort_Call { | |||
| 392 | + | _c.Call.Return(err) | |||
| 393 | + | return _c | |||
| 394 | + | } | |||
| 395 | + | ||||
| 396 | + | func (_c *MockVideoWriter_Abort_Call) RunAndReturn(run func() error) *MockVideoWriter_Abort_Call { | |||
| 397 | + | _c.Call.Return(run) | |||
| 398 | + | return _c | |||
| 399 | + | } | |||
| 400 | + | ||||
| 401 | + | // Close provides a mock function for the type MockVideoWriter | |||
| 402 | + | func (_mock *MockVideoWriter) Close() error { | |||
| 403 | + | ret := _mock.Called() | |||
| 404 | + | ||||
| 405 | + | if len(ret) == 0 { | |||
| 406 | + | panic("no return value specified for Close") | |||
| 407 | + | } | |||
| 408 | + | ||||
| 409 | + | var r0 error | |||
| 410 | + | if returnFunc, ok := ret.Get(0).(func() error); ok { | |||
| 411 | + | r0 = returnFunc() | |||
| 412 | + | } else { | |||
| 413 | + | r0 = ret.Error(0) | |||
| 414 | + | } | |||
| 415 | + | return r0 | |||
| 416 | + | } | |||
| 417 | + | ||||
| 418 | + | // MockVideoWriter_Close_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'Close' | |||
| 419 | + | type MockVideoWriter_Close_Call struct { | |||
| 420 | + | *mock.Call | |||
| 421 | + | } | |||
| 422 | + | ||||
| 423 | + | // Close is a helper method to define mock.On call | |||
| 424 | + | func (_e *MockVideoWriter_Expecter) Close() *MockVideoWriter_Close_Call { | |||
| 425 | + | return &MockVideoWriter_Close_Call{Call: _e.mock.On("Close")} | |||
| 426 | + | } | |||
| 427 | + | ||||
| 428 | + | func (_c *MockVideoWriter_Close_Call) Run(run func()) *MockVideoWriter_Close_Call { | |||
| 429 | + | _c.Call.Run(func(args mock.Arguments) { | |||
| 430 | + | run() | |||
| 431 | + | }) | |||
| 432 | + | return _c | |||
| 433 | + | } | |||
| 434 | + | ||||
| 435 | + | func (_c *MockVideoWriter_Close_Call) Return(err error) *MockVideoWriter_Close_Call { | |||
| 436 | + | _c.Call.Return(err) | |||
| 437 | + | return _c | |||
| 438 | + | } | |||
| 439 | + | ||||
| 440 | + | func (_c *MockVideoWriter_Close_Call) RunAndReturn(run func() error) *MockVideoWriter_Close_Call { | |||
| 441 | + | _c.Call.Return(run) | |||
| 442 | + | return _c | |||
| 443 | + | } | |||
| 444 | + | ||||
| 445 | + | // Start provides a mock function for the type MockVideoWriter | |||
| 446 | + | func (_mock *MockVideoWriter) Start(context1 context.Context, frame ports.Frame, s string, videoSettings ports.VideoSettings) error { | |||
| 447 | + | ret := _mock.Called(context1, frame, s, videoSettings) | |||
| 448 | + | ||||
| 449 | + | if len(ret) == 0 { | |||
| 450 | + | panic("no return value specified for Start") | |||
| 451 | + | } | |||
| 452 | + | ||||
| 453 | + | var r0 error | |||
| 454 | + | if returnFunc, ok := ret.Get(0).(func(context.Context, ports.Frame, string, ports.VideoSettings) error); ok { | |||
| 455 | + | r0 = returnFunc(context1, frame, s, videoSettings) | |||
| 456 | + | } else { | |||
| 457 | + | r0 = ret.Error(0) | |||
| 458 | + | } | |||
| 459 | + | return r0 | |||
| 460 | + | } | |||
| 461 | + | ||||
| 462 | + | // MockVideoWriter_Start_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'Start' | |||
| 463 | + | type MockVideoWriter_Start_Call struct { | |||
| 464 | + | *mock.Call | |||
| 465 | + | } | |||
| 466 | + | ||||
| 467 | + | // Start is a helper method to define mock.On call | |||
| 468 | + | // - context1 context.Context | |||
| 469 | + | // - frame ports.Frame | |||
| 470 | + | // - s string | |||
| 471 | + | // - videoSettings ports.VideoSettings | |||
| 472 | + | func (_e *MockVideoWriter_Expecter) Start(context1 any, frame any, s any, videoSettings any) *MockVideoWriter_Start_Call { | |||
| 473 | + | return &MockVideoWriter_Start_Call{Call: _e.mock.On("Start", context1, frame, s, videoSettings)} | |||
| 474 | + | } | |||
| 475 | + | ||||
| 476 | + | func (_c *MockVideoWriter_Start_Call) Run(run func(context1 context.Context, frame ports.Frame, s string, videoSettings ports.VideoSettings)) *MockVideoWriter_Start_Call { | |||
| 477 | + | _c.Call.Run(func(args mock.Arguments) { | |||
| 478 | + | var arg0 context.Context | |||
| 479 | + | if args[0] != nil { | |||
| 480 | + | arg0 = args[0].(context.Context) | |||
| 481 | + | } | |||
| 482 | + | var arg1 ports.Frame | |||
| 483 | + | if args[1] != nil { | |||
| 484 | + | arg1 = args[1].(ports.Frame) | |||
| 485 | + | } | |||
| 486 | + | var arg2 string | |||
| 487 | + | if args[2] != nil { | |||
| 488 | + | arg2 = args[2].(string) | |||
| 489 | + | } | |||
| 490 | + | var arg3 ports.VideoSettings | |||
| 491 | + | if args[3] != nil { | |||
| 492 | + | arg3 = args[3].(ports.VideoSettings) | |||
| 493 | + | } | |||
| 494 | + | run( | |||
| 495 | + | arg0, | |||
| 496 | + | arg1, | |||
| 497 | + | arg2, | |||
| 498 | + | arg3, | |||
| 499 | + | ) | |||
| 500 | + | }) | |||
| 501 | + | return _c | |||
| 502 | + | } | |||
| 503 | + | ||||
| 504 | + | func (_c *MockVideoWriter_Start_Call) Return(err error) *MockVideoWriter_Start_Call { | |||
| 505 | + | _c.Call.Return(err) | |||
| 506 | + | return _c | |||
| 507 | + | } | |||
| 508 | + | ||||
| 509 | + | func (_c *MockVideoWriter_Start_Call) RunAndReturn(run func(context1 context.Context, frame ports.Frame, s string, videoSettings ports.VideoSettings) error) *MockVideoWriter_Start_Call { | |||
| 510 | + | _c.Call.Return(run) | |||
| 511 | + | return _c | |||
| 512 | + | } | |||
| 513 | + | ||||
| 514 | + | // Write provides a mock function for the type MockVideoWriter | |||
| 515 | + | func (_mock *MockVideoWriter) Write(context1 context.Context, frame ports.Frame) error { | |||
| 516 | + | ret := _mock.Called(context1, frame) | |||
| 517 | + | ||||
| 518 | + | if len(ret) == 0 { | |||
| 519 | + | panic("no return value specified for Write") | |||
| 520 | + | } | |||
| 521 | + | ||||
| 522 | + | var r0 error | |||
| 523 | + | if returnFunc, ok := ret.Get(0).(func(context.Context, ports.Frame) error); ok { | |||
| 524 | + | r0 = returnFunc(context1, frame) | |||
| 525 | + | } else { | |||
| 526 | + | r0 = ret.Error(0) | |||
| 527 | + | } | |||
| 528 | + | return r0 | |||
| 529 | + | } | |||
| 530 | + | ||||
| 531 | + | // MockVideoWriter_Write_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'Write' | |||
| 532 | + | type MockVideoWriter_Write_Call struct { | |||
| 533 | + | *mock.Call | |||
| 534 | + | } | |||
| 535 | + | ||||
| 536 | + | // Write is a helper method to define mock.On call | |||
| 537 | + | // - context1 context.Context | |||
| 538 | + | // - frame ports.Frame | |||
| 539 | + | func (_e *MockVideoWriter_Expecter) Write(context1 any, frame any) *MockVideoWriter_Write_Call { | |||
| 540 | + | return &MockVideoWriter_Write_Call{Call: _e.mock.On("Write", context1, frame)} | |||
| 541 | + | } | |||
| 542 | + | ||||
| 543 | + | func (_c *MockVideoWriter_Write_Call) Run(run func(context1 context.Context, frame ports.Frame)) *MockVideoWriter_Write_Call { | |||
| 544 | + | _c.Call.Run(func(args mock.Arguments) { | |||
| 545 | + | var arg0 context.Context | |||
| 546 | + | if args[0] != nil { | |||
| 547 | + | arg0 = args[0].(context.Context) | |||
| 548 | + | } | |||
| 549 | + | var arg1 ports.Frame | |||
| 550 | + | if args[1] != nil { | |||
| 551 | + | arg1 = args[1].(ports.Frame) | |||
| 552 | + | } | |||
| 553 | + | run( | |||
| 554 | + | arg0, | |||
| 555 | + | arg1, | |||
| 556 | + | ) | |||
| 557 | + | }) | |||
| 558 | + | return _c | |||
| 559 | + | } | |||
| 560 | + | ||||
| 561 | + | func (_c *MockVideoWriter_Write_Call) Return(err error) *MockVideoWriter_Write_Call { | |||
| 562 | + | _c.Call.Return(err) | |||
| 563 | + | return _c | |||
| 564 | + | } | |||
| 565 | + | ||||
| 566 | + | func (_c *MockVideoWriter_Write_Call) RunAndReturn(run func(context1 context.Context, frame ports.Frame) error) *MockVideoWriter_Write_Call { | |||
| 567 | + | _c.Call.Return(run) | |||
| 568 | + | return _c | |||
| 569 | + | } | |||
| 570 | + | ||||
| 571 | + | // NewMockSelector creates a new instance of MockSelector. It also registers a testing interface on the mock and a cleanup function to assert the mocks expectations. | |||
| 572 | + | // The first argument is typically a *testing.T value. | |||
| 573 | + | func NewMockSelector(t interface { | |||
| 574 | + | mock.TestingT | |||
| 575 | + | Cleanup(func()) | |||
| 576 | + | }) *MockSelector { | |||
| 577 | + | if helper, ok := t.(interface{ Helper() }); ok { | |||
| 578 | + | helper.Helper() | |||
| 579 | + | } | |||
| 580 | + | ||||
| 581 | + | mock := &MockSelector{} | |||
| 582 | + | mock.Mock.Test(t) | |||
| 583 | + | ||||
| 584 | + | t.Cleanup(func() { | |||
| 585 | + | if helper, ok := t.(interface{ Helper() }); ok { | |||
| 586 | + | helper.Helper() | |||
| 587 | + | } | |||
| 588 | + | mock.AssertExpectations(t) | |||
| 589 | + | }) | |||
| 590 | + | ||||
| 591 | + | return mock | |||
| 592 | + | } | |||
| 593 | + | ||||
| 594 | + | // MockSelector is an autogenerated mock type for the Selector type | |||
| 595 | + | type MockSelector struct { | |||
| 596 | + | mock.Mock | |||
| 597 | + | } | |||
| 598 | + | ||||
| 599 | + | type MockSelector_Expecter struct { | |||
| 600 | + | mock *mock.Mock | |||
| 601 | + | } | |||
| 602 | + | ||||
| 603 | + | func (_m *MockSelector) EXPECT() *MockSelector_Expecter { | |||
| 604 | + | return &MockSelector_Expecter{mock: &_m.Mock} | |||
| 605 | + | } | |||
| 606 | + | ||||
| 607 | + | // Select provides a mock function for the type MockSelector | |||
| 608 | + | func (_mock *MockSelector) Select(context1 context.Context, outputs []ports.Output) (ports.Selection, bool, error) { | |||
| 609 | + | ret := _mock.Called(context1, outputs) | |||
| 610 | + | ||||
| 611 | + | if len(ret) == 0 { | |||
| 612 | + | panic("no return value specified for Select") | |||
| 613 | + | } | |||
| 614 | + | ||||
| 615 | + | var r0 ports.Selection | |||
| 616 | + | var r1 bool | |||
| 617 | + | var r2 error | |||
| 618 | + | if returnFunc, ok := ret.Get(0).(func(context.Context, []ports.Output) (ports.Selection, bool, error)); ok { | |||
| 619 | + | return returnFunc(context1, outputs) | |||
| 620 | + | } | |||
| 621 | + | if returnFunc, ok := ret.Get(0).(func(context.Context, []ports.Output) ports.Selection); ok { | |||
| 622 | + | r0 = returnFunc(context1, outputs) | |||
| 623 | + | } else { | |||
| 624 | + | r0 = ret.Get(0).(ports.Selection) | |||
| 625 | + | } | |||
| 626 | + | if returnFunc, ok := ret.Get(1).(func(context.Context, []ports.Output) bool); ok { | |||
| 627 | + | r1 = returnFunc(context1, outputs) | |||
| 628 | + | } else { | |||
| 629 | + | r1 = ret.Get(1).(bool) | |||
| 630 | + | } | |||
| 631 | + | if returnFunc, ok := ret.Get(2).(func(context.Context, []ports.Output) error); ok { | |||
| 632 | + | r2 = returnFunc(context1, outputs) | |||
| 633 | + | } else { | |||
| 634 | + | r2 = ret.Error(2) | |||
| 635 | + | } | |||
| 636 | + | return r0, r1, r2 | |||
| 637 | + | } | |||
| 638 | + | ||||
| 639 | + | // MockSelector_Select_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'Select' | |||
| 640 | + | type MockSelector_Select_Call struct { | |||
| 641 | + | *mock.Call | |||
| 642 | + | } | |||
| 643 | + | ||||
| 644 | + | // Select is a helper method to define mock.On call | |||
| 645 | + | // - context1 context.Context | |||
| 646 | + | // - outputs []ports.Output | |||
| 647 | + | func (_e *MockSelector_Expecter) Select(context1 any, outputs any) *MockSelector_Select_Call { | |||
| 648 | + | return &MockSelector_Select_Call{Call: _e.mock.On("Select", context1, outputs)} | |||
| 649 | + | } | |||
| 650 | + | ||||
| 651 | + | func (_c *MockSelector_Select_Call) Run(run func(context1 context.Context, outputs []ports.Output)) *MockSelector_Select_Call { | |||
| 652 | + | _c.Call.Run(func(args mock.Arguments) { | |||
| 653 | + | var arg0 context.Context | |||
| 654 | + | if args[0] != nil { | |||
| 655 | + | arg0 = args[0].(context.Context) | |||
| 656 | + | } | |||
| 657 | + | var arg1 []ports.Output | |||
| 658 | + | if args[1] != nil { | |||
| 659 | + | arg1 = args[1].([]ports.Output) | |||
| 660 | + | } | |||
| 661 | + | run( | |||
| 662 | + | arg0, | |||
| 663 | + | arg1, | |||
| 664 | + | ) | |||
| 665 | + | }) | |||
| 666 | + | return _c | |||
| 667 | + | } | |||
| 668 | + | ||||
| 669 | + | func (_c *MockSelector_Select_Call) Return(selection ports.Selection, b bool, err error) *MockSelector_Select_Call { | |||
| 670 | + | _c.Call.Return(selection, b, err) | |||
| 671 | + | return _c | |||
| 672 | + | } | |||
| 673 | + | ||||
| 674 | + | func (_c *MockSelector_Select_Call) RunAndReturn(run func(context1 context.Context, outputs []ports.Output) (ports.Selection, bool, error)) *MockSelector_Select_Call { | |||
| 675 | + | _c.Call.Return(run) | |||
| 676 | + | return _c | |||
| 677 | + | } | |||
A internal/ports/capture.go +97 -0
| @@ -0,0 +1,97 @@ | |||
| 1 | + | // Package ports defines framework-independent capture contracts. | |
| 2 | + | package ports | |
| 3 | + | ||
| 4 | + | import ( | |
| 5 | + | "context" | |
| 6 | + | "time" | |
| 7 | + | ) | |
| 8 | + | ||
| 9 | + | // Output IDs are stable only within a Source connection. Name is wl_output.name. | |
| 10 | + | type Output struct { | |
| 11 | + | ID uint32 | |
| 12 | + | Name string | |
| 13 | + | Width, Height int // physical mode dimensions, informational | |
| 14 | + | Scale int | |
| 15 | + | } | |
| 16 | + | ||
| 17 | + | // Region uses output-local logical coordinates. Zero value means the full output. | |
| 18 | + | type Region struct{ X, Y, Width, Height int } | |
| 19 | + | ||
| 20 | + | type Target struct { | |
| 21 | + | OutputID uint32 | |
| 22 | + | Region Region | |
| 23 | + | } | |
| 24 | + | ||
| 25 | + | // PixelFormat names the native little-endian wl_shm 32-bit pixel layout. | |
| 26 | + | type PixelFormat uint32 | |
| 27 | + | ||
| 28 | + | const ( | |
| 29 | + | ARGB8888 PixelFormat = 0 | |
| 30 | + | XRGB8888 PixelFormat = 1 | |
| 31 | + | ) | |
| 32 | + | ||
| 33 | + | // Frame borrows storage from Source until the next Capture or Close call. | |
| 34 | + | // Consumers must finish reading synchronously and must not retain Pixels. | |
| 35 | + | // YInvert means the first stored row is the bottom row. Output is opaque SDR. | |
| 36 | + | type Frame struct { | |
| 37 | + | Pixels []byte | |
| 38 | + | Width, Height, Stride int | |
| 39 | + | Format PixelFormat | |
| 40 | + | YInvert bool | |
| 41 | + | } | |
| 42 | + | ||
| 43 | + | // Source has one sequential owner; cancellation must interrupt blocked I/O. | |
| 44 | + | // A failed Capture invalidates its borrowed frame. Close is idempotent. | |
| 45 | + | type Source interface { | |
| 46 | + | Outputs(context.Context) ([]Output, error) | |
| 47 | + | Capture(context.Context, Target) (Frame, error) | |
| 48 | + | Close() error | |
| 49 | + | } | |
| 50 | + | ||
| 51 | + | // ScreenshotWriter writes an opaque PNG without overwriting an existing path. | |
| 52 | + | // Save completes all reads from borrowed frame storage before returning. | |
| 53 | + | type ScreenshotWriter interface { | |
| 54 | + | Save(context.Context, Frame, string) error | |
| 55 | + | } | |
| 56 | + | ||
| 57 | + | // VideoSettings describes fixed-rate silent SDR video. Zero output dimensions | |
| 58 | + | // retain source resolution. Both dimensions must be specified for scaling. | |
| 59 | + | type VideoSettings struct { | |
| 60 | + | FPS int | |
| 61 | + | Width, Height int | |
| 62 | + | } | |
| 63 | + | ||
| 64 | + | // VideoWriter has one owner. Start fixes input geometry and reserves a new path. | |
| 65 | + | // Write consumes borrowed pixels before returning; it must not queue frames. | |
| 66 | + | // Close drains and finalizes the encoder with a bounded shutdown deadline. | |
| 67 | + | // Abort interrupts pending writes and is safe concurrently with Write. | |
| 68 | + | // Write rejects width, height or format changes with ErrGeometryChanged. | |
| 69 | + | // Stride changes are allowed. Close and Abort are idempotent terminal operations; | |
| 70 | + | // Write after termination returns ErrClosed. Other methods have one owner. | |
| 71 | + | type VideoWriter interface { | |
| 72 | + | Start(context.Context, Frame, string, VideoSettings) error | |
| 73 | + | Write(context.Context, Frame) error | |
| 74 | + | Close() error | |
| 75 | + | Abort() error | |
| 76 | + | } | |
| 77 | + | ||
| 78 | + | type Mode string | |
| 79 | + | ||
| 80 | + | const ( | |
| 81 | + | Screenshot Mode = "screenshot" | |
| 82 | + | Record Mode = "record" | |
| 83 | + | ) | |
| 84 | + | ||
| 85 | + | // Selection is returned by a control panel before capture begins. | |
| 86 | + | type Selection struct { | |
| 87 | + | Mode Mode | |
| 88 | + | Target Target | |
| 89 | + | Path string | |
| 90 | + | Video VideoSettings | |
| 91 | + | Duration time.Duration // zero records until context cancellation | |
| 92 | + | } | |
| 93 | + | ||
| 94 | + | // Selector must close its surface before returning an accepted selection. | |
| 95 | + | type Selector interface { | |
| 96 | + | Select(context.Context, []Output) (Selection, bool, error) | |
| 97 | + | } | |
| @@ -0,0 +1,97 @@ | |||||
| 1 | + | // Package ports defines framework-independent capture contracts. | |||
| 2 | + | package ports | |||
| 3 | + | ||||
| 4 | + | import ( | |||
| 5 | + | "context" | |||
| 6 | + | "time" | |||
| 7 | + | ) | |||
| 8 | + | ||||
| 9 | + | // Output IDs are stable only within a Source connection. Name is wl_output.name. | |||
| 10 | + | type Output struct { | |||
| 11 | + | ID uint32 | |||
| 12 | + | Name string | |||
| 13 | + | Width, Height int // physical mode dimensions, informational | |||
| 14 | + | Scale int | |||
| 15 | + | } | |||
| 16 | + | ||||
| 17 | + | // Region uses output-local logical coordinates. Zero value means the full output. | |||
| 18 | + | type Region struct{ X, Y, Width, Height int } | |||
| 19 | + | ||||
| 20 | + | type Target struct { | |||
| 21 | + | OutputID uint32 | |||
| 22 | + | Region Region | |||
| 23 | + | } | |||
| 24 | + | ||||
| 25 | + | // PixelFormat names the native little-endian wl_shm 32-bit pixel layout. | |||
| 26 | + | type PixelFormat uint32 | |||
| 27 | + | ||||
| 28 | + | const ( | |||
| 29 | + | ARGB8888 PixelFormat = 0 | |||
| 30 | + | XRGB8888 PixelFormat = 1 | |||
| 31 | + | ) | |||
| 32 | + | ||||
| 33 | + | // Frame borrows storage from Source until the next Capture or Close call. | |||
| 34 | + | // Consumers must finish reading synchronously and must not retain Pixels. | |||
| 35 | + | // YInvert means the first stored row is the bottom row. Output is opaque SDR. | |||
| 36 | + | type Frame struct { | |||
| 37 | + | Pixels []byte | |||
| 38 | + | Width, Height, Stride int | |||
| 39 | + | Format PixelFormat | |||
| 40 | + | YInvert bool | |||
| 41 | + | } | |||
| 42 | + | ||||
| 43 | + | // Source has one sequential owner; cancellation must interrupt blocked I/O. | |||
| 44 | + | // A failed Capture invalidates its borrowed frame. Close is idempotent. | |||
| 45 | + | type Source interface { | |||
| 46 | + | Outputs(context.Context) ([]Output, error) | |||
| 47 | + | Capture(context.Context, Target) (Frame, error) | |||
| 48 | + | Close() error | |||
| 49 | + | } | |||
| 50 | + | ||||
| 51 | + | // ScreenshotWriter writes an opaque PNG without overwriting an existing path. | |||
| 52 | + | // Save completes all reads from borrowed frame storage before returning. | |||
| 53 | + | type ScreenshotWriter interface { | |||
| 54 | + | Save(context.Context, Frame, string) error | |||
| 55 | + | } | |||
| 56 | + | ||||
| 57 | + | // VideoSettings describes fixed-rate silent SDR video. Zero output dimensions | |||
| 58 | + | // retain source resolution. Both dimensions must be specified for scaling. | |||
| 59 | + | type VideoSettings struct { | |||
| 60 | + | FPS int | |||
| 61 | + | Width, Height int | |||
| 62 | + | } | |||
| 63 | + | ||||
| 64 | + | // VideoWriter has one owner. Start fixes input geometry and reserves a new path. | |||
| 65 | + | // Write consumes borrowed pixels before returning; it must not queue frames. | |||
| 66 | + | // Close drains and finalizes the encoder with a bounded shutdown deadline. | |||
| 67 | + | // Abort interrupts pending writes and is safe concurrently with Write. | |||
| 68 | + | // Write rejects width, height or format changes with ErrGeometryChanged. | |||
| 69 | + | // Stride changes are allowed. Close and Abort are idempotent terminal operations; | |||
| 70 | + | // Write after termination returns ErrClosed. Other methods have one owner. | |||
| 71 | + | type VideoWriter interface { | |||
| 72 | + | Start(context.Context, Frame, string, VideoSettings) error | |||
| 73 | + | Write(context.Context, Frame) error | |||
| 74 | + | Close() error | |||
| 75 | + | Abort() error | |||
| 76 | + | } | |||
| 77 | + | ||||
| 78 | + | type Mode string | |||
| 79 | + | ||||
| 80 | + | const ( | |||
| 81 | + | Screenshot Mode = "screenshot" | |||
| 82 | + | Record Mode = "record" | |||
| 83 | + | ) | |||
| 84 | + | ||||
| 85 | + | // Selection is returned by a control panel before capture begins. | |||
| 86 | + | type Selection struct { | |||
| 87 | + | Mode Mode | |||
| 88 | + | Target Target | |||
| 89 | + | Path string | |||
| 90 | + | Video VideoSettings | |||
| 91 | + | Duration time.Duration // zero records until context cancellation | |||
| 92 | + | } | |||
| 93 | + | ||||
| 94 | + | // Selector must close its surface before returning an accepted selection. | |||
| 95 | + | type Selector interface { | |||
| 96 | + | Select(context.Context, []Output) (Selection, bool, error) | |||
| 97 | + | } | |||
A internal/ports/errors.go +12 -0
| @@ -0,0 +1,12 @@ | |||
| 1 | + | package ports | |
| 2 | + | ||
| 3 | + | import "errors" | |
| 4 | + | ||
| 5 | + | var ( | |
| 6 | + | ErrClosed = errors.New("capture resource is closed") | |
| 7 | + | ErrGeometryChanged = errors.New("capture geometry or pixel format changed") | |
| 8 | + | ErrUnsupportedFormat = errors.New("unsupported capture pixel format") | |
| 9 | + | ErrInvalidRegion = errors.New("invalid output-local capture region") | |
| 10 | + | ErrOutputNotFound = errors.New("capture output not found") | |
| 11 | + | ErrPathExists = errors.New("capture path already exists") | |
| 12 | + | ) | |
| @@ -0,0 +1,12 @@ | |||||
| 1 | + | package ports | |||
| 2 | + | ||||
| 3 | + | import "errors" | |||
| 4 | + | ||||
| 5 | + | var ( | |||
| 6 | + | ErrClosed = errors.New("capture resource is closed") | |||
| 7 | + | ErrGeometryChanged = errors.New("capture geometry or pixel format changed") | |||
| 8 | + | ErrUnsupportedFormat = errors.New("unsupported capture pixel format") | |||
| 9 | + | ErrInvalidRegion = errors.New("invalid output-local capture region") | |||
| 10 | + | ErrOutputNotFound = errors.New("capture output not found") | |||
| 11 | + | ErrPathExists = errors.New("capture path already exists") | |||
| 12 | + | ) | |||
A internal/ports/frame.go +37 -0
| @@ -0,0 +1,37 @@ | |||
| 1 | + | package ports | |
| 2 | + | ||
| 3 | + | import "fmt" | |
| 4 | + | ||
| 5 | + | const ( | |
| 6 | + | BytesPerPixel = 4 | |
| 7 | + | MaxDimension = 16384 | |
| 8 | + | MaxFrameBytes = 256 << 20 | |
| 9 | + | MaxFPS = 120 | |
| 10 | + | ) | |
| 11 | + | ||
| 12 | + | // Validate bounds all arithmetic before adapters map or consume shared storage. | |
| 13 | + | func (f Frame) Validate() error { | |
| 14 | + | if f.Width < 1 || f.Height < 1 || f.Width > MaxDimension || f.Height > MaxDimension { | |
| 15 | + | return fmt.Errorf("invalid frame dimensions %dx%d", f.Width, f.Height) | |
| 16 | + | } | |
| 17 | + | if f.Stride < f.Width*BytesPerPixel || f.Stride%BytesPerPixel != 0 || f.Stride > MaxFrameBytes/f.Height { | |
| 18 | + | return fmt.Errorf("invalid frame stride %d", f.Stride) | |
| 19 | + | } | |
| 20 | + | if f.Format != XRGB8888 && f.Format != ARGB8888 { | |
| 21 | + | return fmt.Errorf("%w: %d", ErrUnsupportedFormat, f.Format) | |
| 22 | + | } | |
| 23 | + | if len(f.Pixels) < f.Stride*f.Height { | |
| 24 | + | return fmt.Errorf("short frame storage: got %d bytes", len(f.Pixels)) | |
| 25 | + | } | |
| 26 | + | return nil | |
| 27 | + | } | |
| 28 | + | ||
| 29 | + | // Row returns a packed view in top-to-bottom order, excluding stride padding. | |
| 30 | + | // Call Validate before using Row. The returned slice borrows frame storage. | |
| 31 | + | func (f Frame) Row(y int) []byte { | |
| 32 | + | if f.YInvert { | |
| 33 | + | y = f.Height - 1 - y | |
| 34 | + | } | |
| 35 | + | offset := y * f.Stride | |
| 36 | + | return f.Pixels[offset : offset+f.Width*BytesPerPixel] | |
| 37 | + | } | |
| @@ -0,0 +1,37 @@ | |||||
| 1 | + | package ports | |||
| 2 | + | ||||
| 3 | + | import "fmt" | |||
| 4 | + | ||||
| 5 | + | const ( | |||
| 6 | + | BytesPerPixel = 4 | |||
| 7 | + | MaxDimension = 16384 | |||
| 8 | + | MaxFrameBytes = 256 << 20 | |||
| 9 | + | MaxFPS = 120 | |||
| 10 | + | ) | |||
| 11 | + | ||||
| 12 | + | // Validate bounds all arithmetic before adapters map or consume shared storage. | |||
| 13 | + | func (f Frame) Validate() error { | |||
| 14 | + | if f.Width < 1 || f.Height < 1 || f.Width > MaxDimension || f.Height > MaxDimension { | |||
| 15 | + | return fmt.Errorf("invalid frame dimensions %dx%d", f.Width, f.Height) | |||
| 16 | + | } | |||
| 17 | + | if f.Stride < f.Width*BytesPerPixel || f.Stride%BytesPerPixel != 0 || f.Stride > MaxFrameBytes/f.Height { | |||
| 18 | + | return fmt.Errorf("invalid frame stride %d", f.Stride) | |||
| 19 | + | } | |||
| 20 | + | if f.Format != XRGB8888 && f.Format != ARGB8888 { | |||
| 21 | + | return fmt.Errorf("%w: %d", ErrUnsupportedFormat, f.Format) | |||
| 22 | + | } | |||
| 23 | + | if len(f.Pixels) < f.Stride*f.Height { | |||
| 24 | + | return fmt.Errorf("short frame storage: got %d bytes", len(f.Pixels)) | |||
| 25 | + | } | |||
| 26 | + | return nil | |||
| 27 | + | } | |||
| 28 | + | ||||
| 29 | + | // Row returns a packed view in top-to-bottom order, excluding stride padding. | |||
| 30 | + | // Call Validate before using Row. The returned slice borrows frame storage. | |||
| 31 | + | func (f Frame) Row(y int) []byte { | |||
| 32 | + | if f.YInvert { | |||
| 33 | + | y = f.Height - 1 - y | |||
| 34 | + | } | |||
| 35 | + | offset := y * f.Stride | |||
| 36 | + | return f.Pixels[offset : offset+f.Width*BytesPerPixel] | |||
| 37 | + | } | |||
A internal/ports/frame_test.go +73 -0
| @@ -0,0 +1,73 @@ | |||
| 1 | + | package ports | |
| 2 | + | ||
| 3 | + | import ( | |
| 4 | + | "testing" | |
| 5 | + | ) | |
| 6 | + | ||
| 7 | + | func TestFrameValidation(t *testing.T) { | |
| 8 | + | valid := Frame{Pixels: make([]byte, 24), Width: 2, Height: 2, Stride: 12, Format: XRGB8888} | |
| 9 | + | if err := valid.Validate(); err != nil { | |
| 10 | + | t.Fatal(err) | |
| 11 | + | } | |
| 12 | + | cases := []struct { | |
| 13 | + | name string | |
| 14 | + | change func(*Frame) | |
| 15 | + | }{ | |
| 16 | + | {"zero width", func(f *Frame) { f.Width = 0 }}, | |
| 17 | + | {"negative height", func(f *Frame) { f.Height = -1 }}, | |
| 18 | + | {"oversized width", func(f *Frame) { f.Width = MaxDimension + 1 }}, | |
| 19 | + | {"short stride", func(f *Frame) { f.Stride = 7 }}, | |
| 20 | + | {"oversized storage", func(f *Frame) { f.Stride = MaxFrameBytes }}, | |
| 21 | + | {"unsupported format", func(f *Frame) { f.Format = 42 }}, | |
| 22 | + | {"short storage", func(f *Frame) { f.Pixels = f.Pixels[:23] }}, | |
| 23 | + | } | |
| 24 | + | for _, tc := range cases { | |
| 25 | + | t.Run(tc.name, func(t *testing.T) { | |
| 26 | + | f := valid | |
| 27 | + | tc.change(&f) | |
| 28 | + | if f.Validate() == nil { | |
| 29 | + | t.Fatal("accepted invalid frame") | |
| 30 | + | } | |
| 31 | + | }) | |
| 32 | + | } | |
| 33 | + | } | |
| 34 | + | ||
| 35 | + | func TestFrameRow(t *testing.T) { | |
| 36 | + | f := Frame{Pixels: []byte{1, 2, 3, 4, 99, 99, 99, 99, 5, 6, 7, 8, 99, 99, 99, 99}, Width: 1, Height: 2, Stride: 8, Format: ARGB8888} | |
| 37 | + | if err := f.Validate(); err != nil { | |
| 38 | + | t.Fatal(err) | |
| 39 | + | } | |
| 40 | + | if got := f.Row(0); len(got) != 4 || got[0] != 1 { | |
| 41 | + | t.Fatalf("row: %v", got) | |
| 42 | + | } | |
| 43 | + | f.YInvert = true | |
| 44 | + | if got := f.Row(0); len(got) != 4 || got[0] != 5 { | |
| 45 | + | t.Fatalf("inverted row: %v", got) | |
| 46 | + | } | |
| 47 | + | } | |
| 48 | + | ||
| 49 | + | func TestFrameAllocations(t *testing.T) { | |
| 50 | + | f := Frame{Pixels: make([]byte, 16), Width: 2, Height: 2, Stride: 8, Format: XRGB8888} | |
| 51 | + | if allocs := testing.AllocsPerRun(1000, func() { | |
| 52 | + | if f.Validate() != nil { | |
| 53 | + | panic("invalid test frame") | |
| 54 | + | } | |
| 55 | + | _ = f.Row(0) | |
| 56 | + | }); allocs != 0 { | |
| 57 | + | t.Fatalf("frame view: %g allocations", allocs) | |
| 58 | + | } | |
| 59 | + | } | |
| 60 | + | ||
| 61 | + | func BenchmarkFrameRows(b *testing.B) { | |
| 62 | + | f := Frame{Pixels: make([]byte, 1920*1080*4), Width: 1920, Height: 1080, Stride: 1920 * 4, Format: XRGB8888} | |
| 63 | + | b.ReportAllocs() | |
| 64 | + | b.ResetTimer() | |
| 65 | + | for b.Loop() { | |
| 66 | + | if err := f.Validate(); err != nil { | |
| 67 | + | b.Fatal(err) | |
| 68 | + | } | |
| 69 | + | for y := 0; y < f.Height; y++ { | |
| 70 | + | _ = f.Row(y) | |
| 71 | + | } | |
| 72 | + | } | |
| 73 | + | } | |
| @@ -0,0 +1,73 @@ | |||||
| 1 | + | package ports | |||
| 2 | + | ||||
| 3 | + | import ( | |||
| 4 | + | "testing" | |||
| 5 | + | ) | |||
| 6 | + | ||||
| 7 | + | func TestFrameValidation(t *testing.T) { | |||
| 8 | + | valid := Frame{Pixels: make([]byte, 24), Width: 2, Height: 2, Stride: 12, Format: XRGB8888} | |||
| 9 | + | if err := valid.Validate(); err != nil { | |||
| 10 | + | t.Fatal(err) | |||
| 11 | + | } | |||
| 12 | + | cases := []struct { | |||
| 13 | + | name string | |||
| 14 | + | change func(*Frame) | |||
| 15 | + | }{ | |||
| 16 | + | {"zero width", func(f *Frame) { f.Width = 0 }}, | |||
| 17 | + | {"negative height", func(f *Frame) { f.Height = -1 }}, | |||
| 18 | + | {"oversized width", func(f *Frame) { f.Width = MaxDimension + 1 }}, | |||
| 19 | + | {"short stride", func(f *Frame) { f.Stride = 7 }}, | |||
| 20 | + | {"oversized storage", func(f *Frame) { f.Stride = MaxFrameBytes }}, | |||
| 21 | + | {"unsupported format", func(f *Frame) { f.Format = 42 }}, | |||
| 22 | + | {"short storage", func(f *Frame) { f.Pixels = f.Pixels[:23] }}, | |||
| 23 | + | } | |||
| 24 | + | for _, tc := range cases { | |||
| 25 | + | t.Run(tc.name, func(t *testing.T) { | |||
| 26 | + | f := valid | |||
| 27 | + | tc.change(&f) | |||
| 28 | + | if f.Validate() == nil { | |||
| 29 | + | t.Fatal("accepted invalid frame") | |||
| 30 | + | } | |||
| 31 | + | }) | |||
| 32 | + | } | |||
| 33 | + | } | |||
| 34 | + | ||||
| 35 | + | func TestFrameRow(t *testing.T) { | |||
| 36 | + | f := Frame{Pixels: []byte{1, 2, 3, 4, 99, 99, 99, 99, 5, 6, 7, 8, 99, 99, 99, 99}, Width: 1, Height: 2, Stride: 8, Format: ARGB8888} | |||
| 37 | + | if err := f.Validate(); err != nil { | |||
| 38 | + | t.Fatal(err) | |||
| 39 | + | } | |||
| 40 | + | if got := f.Row(0); len(got) != 4 || got[0] != 1 { | |||
| 41 | + | t.Fatalf("row: %v", got) | |||
| 42 | + | } | |||
| 43 | + | f.YInvert = true | |||
| 44 | + | if got := f.Row(0); len(got) != 4 || got[0] != 5 { | |||
| 45 | + | t.Fatalf("inverted row: %v", got) | |||
| 46 | + | } | |||
| 47 | + | } | |||
| 48 | + | ||||
| 49 | + | func TestFrameAllocations(t *testing.T) { | |||
| 50 | + | f := Frame{Pixels: make([]byte, 16), Width: 2, Height: 2, Stride: 8, Format: XRGB8888} | |||
| 51 | + | if allocs := testing.AllocsPerRun(1000, func() { | |||
| 52 | + | if f.Validate() != nil { | |||
| 53 | + | panic("invalid test frame") | |||
| 54 | + | } | |||
| 55 | + | _ = f.Row(0) | |||
| 56 | + | }); allocs != 0 { | |||
| 57 | + | t.Fatalf("frame view: %g allocations", allocs) | |||
| 58 | + | } | |||
| 59 | + | } | |||
| 60 | + | ||||
| 61 | + | func BenchmarkFrameRows(b *testing.B) { | |||
| 62 | + | f := Frame{Pixels: make([]byte, 1920*1080*4), Width: 1920, Height: 1080, Stride: 1920 * 4, Format: XRGB8888} | |||
| 63 | + | b.ReportAllocs() | |||
| 64 | + | b.ResetTimer() | |||
| 65 | + | for b.Loop() { | |||
| 66 | + | if err := f.Validate(); err != nil { | |||
| 67 | + | b.Fatal(err) | |||
| 68 | + | } | |||
| 69 | + | for y := 0; y < f.Height; y++ { | |||
| 70 | + | _ = f.Row(y) | |||
| 71 | + | } | |||
| 72 | + | } | |||
| 73 | + | } | |||