├── .dockerignore ├── .editorconfig ├── .golangci.yaml ├── LICENSE ├── README.md ├── cmd ├── architecture.go ├── root.go ├── search.go ├── show.go ├── submit.go └── version.go ├── go.mod ├── go.sum ├── init ├── pkgstats.service └── pkgstats.timer ├── internal ├── api │ ├── request │ │ ├── client.go │ │ ├── printer.go │ │ └── validator.go │ └── submit │ │ ├── client.go │ │ └── request.go ├── build │ └── config.go ├── pacman │ ├── config_map.go │ ├── packages.go │ ├── parser.go │ └── server.go └── system │ ├── system.go │ ├── system_386.go │ ├── system_386.s │ ├── system_amd64.go │ ├── system_arm.go │ ├── system_arm64.go │ ├── system_goarch.go │ ├── system_goos.go │ └── system_linux.go ├── just ├── aarch64.just ├── arm.just ├── dev.just ├── i686.just ├── loongarch64.just ├── riscv64.just └── x86_64.just ├── justfile ├── main.go └── tests ├── integration ├── Dockerfile ├── integration_test.go ├── mock_pacman_test.go ├── mock_server_test.go ├── pacman_test.go ├── pkgstats_test.go └── submit_request_bench_test.go └── unit └── internal ├── api ├── aubmit │ └── client_test.go └── request │ ├── client_test.go │ ├── printer_test.go │ └── validator_test.go ├── build └── version_test.go ├── pacman └── pacman_test.go └── system ├── system_386_test.go ├── system_amd64_test.go ├── system_arm64_test.go ├── system_arm_test.go ├── system_goarch_test.go ├── system_goos_test.go └── system_linux_test.go /.dockerignore: -------------------------------------------------------------------------------- 1 | /.idea 2 | /.github 3 | /pkgstats 4 | /pkgstats-cli 5 | /*.out 6 | /tests/integration/Dockerfile 7 | /tests/build 8 | -------------------------------------------------------------------------------- /.editorconfig: -------------------------------------------------------------------------------- 1 | root = true 2 | 3 | [*] 4 | end_of_line = lf 5 | charset = utf-8 6 | indent_style = tab 7 | insert_final_newline = true 8 | trim_trailing_whitespace = true 9 | 10 | [*.yml] 11 | indent_size = 2 12 | indent_style = space 13 | -------------------------------------------------------------------------------- /.golangci.yaml: -------------------------------------------------------------------------------- 1 | version: "2" 2 | linters: 3 | enable: 4 | - bodyclose 5 | - dupl 6 | - errorlint 7 | - goconst 8 | - gocritic 9 | - gocyclo 10 | - gosec 11 | - misspell 12 | - mnd 13 | - musttag 14 | - perfsprint 15 | - testpackage 16 | - unparam 17 | - usestdlibvars 18 | exclusions: 19 | generated: lax 20 | presets: 21 | - comments 22 | - common-false-positives 23 | - legacy 24 | - std-error-handling 25 | rules: 26 | - linters: 27 | - perfsprint 28 | path: _test\.go 29 | paths: 30 | - third_party$ 31 | - builtin$ 32 | - examples$ 33 | formatters: 34 | enable: 35 | - gofumpt 36 | settings: 37 | gofumpt: 38 | module-path: pkgstats-cli 39 | exclusions: 40 | generated: lax 41 | paths: 42 | - third_party$ 43 | - builtin$ 44 | - examples$ 45 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 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 | 635 | Copyright (C) 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 . 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 | Copyright (C) 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 | . 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 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # pkgstats-cli 2 | pkgstats client submits a list of installed packages to the Arch Linux project at [pkgstats.archlinux.de](https://pkgstats.archlinux.de/) 3 | -------------------------------------------------------------------------------- /cmd/architecture.go: -------------------------------------------------------------------------------- 1 | package cmd 2 | 3 | import ( 4 | "fmt" 5 | 6 | "pkgstats-cli/internal/system" 7 | 8 | "github.com/spf13/cobra" 9 | ) 10 | 11 | var architectureCmd = &cobra.Command{ 12 | Use: "architecture", 13 | Aliases: []string{"arch"}, 14 | Short: "Shows information about CPU and OS architecture", 15 | Hidden: true, 16 | Args: cobra.NoArgs, 17 | RunE: func(cmd *cobra.Command, args []string) error { 18 | s := system.NewSystem() 19 | 20 | osArchitecture, err := s.GetArchitecture() 21 | if err != nil { 22 | return fmt.Errorf("could not get OS architecture: %w", err) 23 | } 24 | 25 | systemArchitecture, err := s.GetCpuArchitecture() 26 | if err != nil { 27 | return fmt.Errorf("could not get CPU architecture: %w", err) 28 | } 29 | 30 | fmt.Fprintf(cmd.OutOrStdout(), "You are using a %s CPU on a %s OS\n", systemArchitecture, osArchitecture) 31 | 32 | return nil 33 | }, 34 | } 35 | 36 | var osArchitectureCommand = &cobra.Command{ 37 | Use: "os", 38 | Short: "Shows OS architecture", 39 | Args: cobra.NoArgs, 40 | RunE: func(cmd *cobra.Command, args []string) error { 41 | s := system.NewSystem() 42 | 43 | osArchitecture, err := s.GetArchitecture() 44 | if err != nil { 45 | return fmt.Errorf("could not get OS architecture: %w", err) 46 | } 47 | 48 | fmt.Fprintln(cmd.OutOrStdout(), osArchitecture) 49 | 50 | return nil 51 | }, 52 | } 53 | 54 | var systemArchitectureCommand = &cobra.Command{ 55 | Use: "system", 56 | Aliases: []string{"cpu"}, 57 | Short: "Shows CPU architecture", 58 | Args: cobra.NoArgs, 59 | RunE: func(cmd *cobra.Command, args []string) error { 60 | s := system.NewSystem() 61 | 62 | systemArchitecture, err := s.GetCpuArchitecture() 63 | if err != nil { 64 | return fmt.Errorf("could not get CPU architecture: %w", err) 65 | } 66 | 67 | fmt.Fprintln(cmd.OutOrStdout(), systemArchitecture) 68 | 69 | return nil 70 | }, 71 | } 72 | 73 | func init() { 74 | rootCmd.AddCommand(architectureCmd) 75 | architectureCmd.AddCommand(osArchitectureCommand) 76 | architectureCmd.AddCommand(systemArchitectureCommand) 77 | } 78 | -------------------------------------------------------------------------------- /cmd/root.go: -------------------------------------------------------------------------------- 1 | package cmd 2 | 3 | import ( 4 | "fmt" 5 | "os" 6 | 7 | "pkgstats-cli/internal/build" 8 | 9 | "github.com/spf13/cobra" 10 | ) 11 | 12 | const ( 13 | baseUrlParam = "base-url" 14 | pacmanConfParam = "pacman-conf" 15 | ) 16 | 17 | var ( 18 | baseURL = "https://pkgstats.archlinux.de" 19 | pacmanConf = "/etc/pacman.conf" 20 | rootCmd = &cobra.Command{ 21 | Use: "pkgstats", 22 | Short: "pkgstats client", 23 | Version: build.Version, 24 | SilenceUsage: true, 25 | } 26 | ) 27 | 28 | func Execute() { 29 | if err := rootCmd.Execute(); err != nil { 30 | os.Exit(1) 31 | } 32 | } 33 | 34 | func init() { 35 | rootCmd.PersistentFlags().StringVar(&baseURL, baseUrlParam, baseURL, "base url of the pkgstats server") 36 | if err := rootCmd.PersistentFlags().MarkHidden(baseUrlParam); err != nil { 37 | fmt.Fprintln(rootCmd.ErrOrStderr(), err) 38 | os.Exit(1) 39 | } 40 | 41 | rootCmd.PersistentFlags().StringVar(&pacmanConf, pacmanConfParam, pacmanConf, "path to pacman.conf") 42 | if err := rootCmd.PersistentFlags().MarkHidden(pacmanConfParam); err != nil { 43 | fmt.Fprintln(rootCmd.ErrOrStderr(), err) 44 | os.Exit(1) 45 | } 46 | 47 | rootCmd.CompletionOptions.HiddenDefaultCmd = true 48 | } 49 | 50 | func GetRootCmd() *cobra.Command { 51 | return rootCmd 52 | } 53 | -------------------------------------------------------------------------------- /cmd/search.go: -------------------------------------------------------------------------------- 1 | package cmd 2 | 3 | import ( 4 | "fmt" 5 | 6 | "pkgstats-cli/internal/api/request" 7 | 8 | "github.com/spf13/cobra" 9 | ) 10 | 11 | const ( 12 | minLimit = 1 13 | maxLimit = 10000 14 | ) 15 | 16 | var limit = 10 17 | 18 | var searchCmd = &cobra.Command{ 19 | Use: "search", 20 | Short: "Search packages and list their popularity", 21 | Args: cobra.ExactArgs(1), 22 | RunE: func(cmd *cobra.Command, args []string) error { 23 | if limit < minLimit || limit > maxLimit { 24 | return fmt.Errorf("valid limit needs to be between %d and %d", minLimit, maxLimit) 25 | } 26 | if err := request.ValidatePackageName(args[0]); err != nil { 27 | return err 28 | } 29 | 30 | client := request.NewClient(baseURL) 31 | 32 | ppl, err := client.SearchPackages(args[0], limit) 33 | if err != nil { 34 | return err 35 | } 36 | 37 | request.PrintPackagePopularities(cmd.OutOrStdout(), ppl) 38 | fmt.Fprintln(cmd.OutOrStdout()) 39 | request.PrintSearchURL(cmd.OutOrStdout(), baseURL, args[0]) 40 | 41 | return nil 42 | }, 43 | } 44 | 45 | func init() { 46 | rootCmd.AddCommand(searchCmd) 47 | searchCmd.Flags().IntVarP(&limit, "limit", "l", limit, fmt.Sprintf("Limit the results from %d to %d entries", minLimit, maxLimit)) 48 | } 49 | -------------------------------------------------------------------------------- /cmd/show.go: -------------------------------------------------------------------------------- 1 | package cmd 2 | 3 | import ( 4 | "fmt" 5 | 6 | "pkgstats-cli/internal/api/request" 7 | 8 | "github.com/spf13/cobra" 9 | ) 10 | 11 | const ( 12 | minPackages = 1 13 | maxPackages = 20 14 | ) 15 | 16 | var showCmd = &cobra.Command{ 17 | Use: "show", 18 | Short: "Show one or more packages and compare their popularity", 19 | Args: cobra.RangeArgs(minPackages, maxPackages), 20 | RunE: func(cmd *cobra.Command, args []string) error { 21 | if err := request.ValidatePackageNames(args); err != nil { 22 | return err 23 | } 24 | 25 | client := request.NewClient(baseURL) 26 | 27 | ppl, err := client.GetPackages(args...) 28 | if err != nil { 29 | return err 30 | } 31 | 32 | request.PrintPackagePopularities(cmd.OutOrStdout(), ppl) 33 | fmt.Fprintln(cmd.OutOrStdout()) 34 | request.PrintShowURL(cmd.OutOrStdout(), baseURL, args) 35 | 36 | return nil 37 | }, 38 | } 39 | 40 | func init() { 41 | rootCmd.AddCommand(showCmd) 42 | } 43 | -------------------------------------------------------------------------------- /cmd/submit.go: -------------------------------------------------------------------------------- 1 | package cmd 2 | 3 | import ( 4 | "encoding/json" 5 | "errors" 6 | "fmt" 7 | 8 | "pkgstats-cli/internal/api/submit" 9 | "pkgstats-cli/internal/pacman" 10 | "pkgstats-cli/internal/system" 11 | 12 | "github.com/spf13/cobra" 13 | ) 14 | 15 | var ( 16 | dumpJSON = false 17 | quiet = false 18 | ) 19 | 20 | var submitCmd = &cobra.Command{ 21 | Use: "submit", 22 | Short: "Submit a list of your installed packages to the pkgstats project", 23 | Long: "Submit a list of your installed packages, your system architecture\nand the mirror you are using to the pkgstats project.\n\nStatistics are available at " + baseURL, 24 | Args: cobra.NoArgs, 25 | RunE: func(cmd *cobra.Command, args []string) error { 26 | if dumpJSON && quiet { 27 | return errors.New("--quiet and --dump-json cannot be used at the same time") 28 | } 29 | 30 | if !dumpJSON && !quiet { 31 | fmt.Fprintln(cmd.OutOrStdout(), "Collecting data...") 32 | } 33 | 34 | p, err := pacman.Parse(pacmanConf) 35 | if err != nil { 36 | return err 37 | } 38 | request, err := submit.CreateRequest(p, system.NewSystem()) 39 | if err != nil { 40 | return err 41 | } 42 | 43 | if !dumpJSON { 44 | if !quiet { 45 | fmt.Fprintln(cmd.OutOrStdout(), "Submitting data...") 46 | } 47 | client := submit.NewClient(baseURL) 48 | 49 | err := client.SendRequest(*request) 50 | if err != nil { 51 | return err 52 | } 53 | 54 | if !quiet { 55 | fmt.Fprintln(cmd.OutOrStdout(), "Data were successfully sent") 56 | } 57 | } else { 58 | formattedRequest, err := json.MarshalIndent(request, "", " ") 59 | if err != nil { 60 | return err 61 | } 62 | fmt.Fprintln(cmd.OutOrStdout(), string(formattedRequest)) 63 | } 64 | 65 | return nil 66 | }, 67 | } 68 | 69 | func init() { 70 | rootCmd.AddCommand(submitCmd) 71 | submitCmd.Flags().BoolVarP(&dumpJSON, "dump-json", "d", dumpJSON, "Dump information that would be sent as JSON") 72 | submitCmd.Flags().BoolVarP(&quiet, "quiet", "q", quiet, "Suppress any output except errors") 73 | } 74 | -------------------------------------------------------------------------------- /cmd/version.go: -------------------------------------------------------------------------------- 1 | package cmd 2 | 3 | import ( 4 | "fmt" 5 | 6 | "pkgstats-cli/internal/build" 7 | 8 | "github.com/spf13/cobra" 9 | ) 10 | 11 | var versionCmd = &cobra.Command{ 12 | Use: "version", 13 | Short: "Show the pkgstats client version", 14 | Args: cobra.NoArgs, 15 | Hidden: true, 16 | Run: func(cmd *cobra.Command, args []string) { 17 | fmt.Fprintln(cmd.OutOrStdout(), "pkgstats, version", build.Version) 18 | }, 19 | } 20 | 21 | func init() { 22 | rootCmd.AddCommand(versionCmd) 23 | } 24 | -------------------------------------------------------------------------------- /go.mod: -------------------------------------------------------------------------------- 1 | module pkgstats-cli 2 | 3 | go 1.24 4 | 5 | require ( 6 | github.com/spf13/cobra v1.9.1 7 | github.com/spf13/pflag v1.0.6 8 | golang.org/x/sys v0.33.0 9 | ) 10 | 11 | require github.com/inconshreveable/mousetrap v1.1.0 // indirect 12 | -------------------------------------------------------------------------------- /go.sum: -------------------------------------------------------------------------------- 1 | github.com/cpuguy83/go-md2man/v2 v2.0.6/go.mod h1:oOW0eioCTA6cOiMLiUPZOpcVxMig6NIQQ7OS05n1F4g= 2 | github.com/inconshreveable/mousetrap v1.1.0 h1:wN+x4NVGpMsO7ErUn/mUI3vEoE6Jt13X2s0bqwp9tc8= 3 | github.com/inconshreveable/mousetrap v1.1.0/go.mod h1:vpF70FUmC8bwa3OWnCshd2FqLfsEA9PFc4w1p2J65bw= 4 | github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM= 5 | github.com/spf13/cobra v1.9.1 h1:CXSaggrXdbHK9CF+8ywj8Amf7PBRmPCOJugH954Nnlo= 6 | github.com/spf13/cobra v1.9.1/go.mod h1:nDyEzZ8ogv936Cinf6g1RU9MRY64Ir93oCnqb9wxYW0= 7 | github.com/spf13/pflag v1.0.6 h1:jFzHGLGAlb3ruxLB8MhbI6A8+AQX/2eW4qeyNZXNp2o= 8 | github.com/spf13/pflag v1.0.6/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An2Bg= 9 | golang.org/x/sys v0.33.0 h1:q3i8TbbEz+JRD9ywIRlyRAQbM0qF7hu24q3teo2hbuw= 10 | golang.org/x/sys v0.33.0/go.mod h1:BJP2sWEmIv4KK5OTEluFJCKSidICx8ciO85XgH3Ak8k= 11 | gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= 12 | gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= 13 | -------------------------------------------------------------------------------- /init/pkgstats.service: -------------------------------------------------------------------------------- 1 | [Unit] 2 | Description=Submit pkgstats 3 | After=network-online.target 4 | Wants=network-online.target 5 | 6 | [Service] 7 | Type=oneshot 8 | ExecStart=/usr/bin/pkgstats submit --quiet 9 | 10 | CapabilityBoundingSet= 11 | DevicePolicy=closed 12 | DynamicUser=true 13 | LockPersonality=true 14 | MemoryDenyWriteExecute=true 15 | PrivateDevices=true 16 | PrivateUsers=true 17 | ProcSubset=pid 18 | ProtectClock=true 19 | ProtectControlGroups=true 20 | ProtectHome=true 21 | ProtectHostname=true 22 | ProtectKernelLogs=true 23 | ProtectKernelModules=true 24 | ProtectKernelTunables=true 25 | ProtectProc=invisible 26 | RestrictAddressFamilies=AF_INET AF_INET6 27 | RestrictNamespaces=true 28 | RestrictRealtime=true 29 | SystemCallArchitectures=native 30 | SystemCallFilter=@system-service 31 | SystemCallFilter=~@privileged 32 | -------------------------------------------------------------------------------- /init/pkgstats.timer: -------------------------------------------------------------------------------- 1 | [Unit] 2 | Description=Weekly pkgstats submission 3 | 4 | [Timer] 5 | OnCalendar=weekly 6 | AccuracySec=1d 7 | RandomizedDelaySec=7d 8 | Persistent=true 9 | -------------------------------------------------------------------------------- /internal/api/request/client.go: -------------------------------------------------------------------------------- 1 | package request 2 | 3 | import ( 4 | "encoding/json" 5 | "errors" 6 | "io" 7 | "net/http" 8 | "net/url" 9 | "sort" 10 | "strconv" 11 | "time" 12 | 13 | "pkgstats-cli/internal/build" 14 | ) 15 | 16 | const timeout = 5 * time.Second 17 | 18 | type Client struct { 19 | Client *http.Client 20 | BaseURL string 21 | } 22 | 23 | type PackagePopularity struct { 24 | Name string `json:"name"` 25 | Popularity float64 `json:"popularity"` 26 | } 27 | 28 | type PackagePopularityList struct { 29 | Total int `json:"total"` 30 | Count int `json:"count"` 31 | PackagePopularities []PackagePopularity `json:"packagePopularities"` 32 | } 33 | 34 | type packagePopularityResult struct { 35 | pp PackagePopularity 36 | err error 37 | } 38 | 39 | func NewClient(baseURL string) *Client { 40 | httpClient := &http.Client{ 41 | Timeout: timeout, 42 | } 43 | 44 | return &Client{ 45 | Client: httpClient, 46 | BaseURL: baseURL, 47 | } 48 | } 49 | 50 | func (client *Client) query(path string, params url.Values) ([]byte, error) { 51 | u, err := url.Parse(client.BaseURL) 52 | if err != nil { 53 | return nil, err 54 | } 55 | u = u.JoinPath(path) 56 | 57 | u.RawQuery = params.Encode() 58 | 59 | req, err := http.NewRequest(http.MethodGet, u.String(), nil) 60 | if err != nil { 61 | return nil, err 62 | } 63 | req.Header.Set("Content-Type", "application/json") 64 | req.Header.Set("Accept", "application/json") 65 | req.Header.Set("User-Agent", build.UserAgent) 66 | response, err := client.Client.Do(req) 67 | if err != nil { 68 | return nil, err 69 | } 70 | 71 | if response.StatusCode != http.StatusOK { 72 | return nil, errors.New(http.StatusText(response.StatusCode)) 73 | } 74 | 75 | defer response.Body.Close() 76 | 77 | body, err := io.ReadAll(response.Body) 78 | if err != nil { 79 | return nil, err 80 | } 81 | 82 | return body, nil 83 | } 84 | 85 | func (client *Client) GetPackages(packages ...string) (PackagePopularityList, error) { 86 | ppl := PackagePopularityList{} 87 | ppl.PackagePopularities = make([]PackagePopularity, len(packages)) 88 | 89 | ch := make(chan (packagePopularityResult)) 90 | 91 | for _, p := range packages { 92 | go func(p string, ch chan (packagePopularityResult)) { 93 | res, err := client.GetPackage(p) 94 | ch <- packagePopularityResult{res, err} 95 | }(p, ch) 96 | } 97 | 98 | for i := range packages { 99 | res := <-ch 100 | if res.err != nil { 101 | return PackagePopularityList{}, res.err 102 | } 103 | ppl.PackagePopularities[i] = res.pp 104 | } 105 | 106 | sort.Slice(ppl.PackagePopularities, func(i, j int) bool { 107 | return ppl.PackagePopularities[i].Popularity > ppl.PackagePopularities[j].Popularity 108 | }) 109 | 110 | return ppl, nil 111 | } 112 | 113 | func (client *Client) GetPackage(p string) (PackagePopularity, error) { 114 | response, err := client.query("/api/packages/"+url.PathEscape(p), url.Values{}) 115 | if err != nil { 116 | return PackagePopularity{}, err 117 | } 118 | 119 | var pp PackagePopularity 120 | err = json.Unmarshal(response, &pp) 121 | if err != nil { 122 | return PackagePopularity{}, err 123 | } 124 | 125 | return pp, nil 126 | } 127 | 128 | func (client *Client) SearchPackages(query string, limit int) (PackagePopularityList, error) { 129 | params := url.Values{} 130 | params.Add("limit", strconv.Itoa(limit)) 131 | params.Add("query", query) 132 | 133 | response, err := client.query("/api/packages", params) 134 | if err != nil { 135 | return PackagePopularityList{}, err 136 | } 137 | 138 | var ppl PackagePopularityList 139 | err = json.Unmarshal(response, &ppl) 140 | if err != nil { 141 | return PackagePopularityList{}, err 142 | } 143 | 144 | return ppl, nil 145 | } 146 | -------------------------------------------------------------------------------- /internal/api/request/printer.go: -------------------------------------------------------------------------------- 1 | package request 2 | 3 | import ( 4 | "fmt" 5 | "io" 6 | "net/url" 7 | "sort" 8 | "strings" 9 | "text/tabwriter" 10 | ) 11 | 12 | const ( 13 | minWidth = 15 14 | padding = 2 15 | ) 16 | 17 | func PrintPackagePopularities(writer io.Writer, ppl PackagePopularityList) { 18 | w := tabwriter.NewWriter(writer, minWidth, 0, padding, ' ', 0) 19 | for _, pkg := range ppl.PackagePopularities { 20 | fmt.Fprintf(w, "%s\t%.2f\n", pkg.Name, pkg.Popularity) 21 | } 22 | w.Flush() 23 | 24 | if ppl.Count > 0 && ppl.Total > 0 { 25 | fmt.Fprintf(writer, "\n%d of %d results\n", ppl.Count, ppl.Total) 26 | } 27 | } 28 | 29 | func PrintSearchURL(writer io.Writer, baseURL string, query string) { 30 | if len(query) > 0 { 31 | fmt.Fprintf(writer, "See more results at %s/packages#query=%s\n", baseURL, query) 32 | } 33 | } 34 | 35 | func PrintShowURL(writer io.Writer, baseURL string, packages []string) { 36 | if len(packages) > 0 { 37 | for i, p := range packages { 38 | packages[i] = url.QueryEscape(p) 39 | } 40 | 41 | sort.StringSlice.Sort(packages) 42 | fmt.Fprintf(writer, "See more results at %s/compare/packages#packages=%s\n", baseURL, strings.Join(packages, ",")) 43 | } 44 | } 45 | -------------------------------------------------------------------------------- /internal/api/request/validator.go: -------------------------------------------------------------------------------- 1 | package request 2 | 3 | import ( 4 | "fmt" 5 | "strings" 6 | "unicode/utf8" 7 | ) 8 | 9 | const ( 10 | minLength = 1 11 | maxLength = 190 12 | alphaNumeric = "0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ" 13 | special = "@_+" 14 | delimiter = ".-" 15 | validFirstChar = alphaNumeric + special 16 | validChars = validFirstChar + delimiter 17 | ) 18 | 19 | func ValidatePackageName(name string) error { 20 | length := len(name) 21 | if length < minLength || length > maxLength { 22 | return fmt.Errorf("length must be between %d and %d characters, %d were given", minLength, maxLength, length) 23 | } 24 | 25 | firstChar, _ := utf8.DecodeRuneInString(name) 26 | if !strings.ContainsRune(validFirstChar, firstChar) { 27 | return fmt.Errorf("invalid character '%c'", firstChar) 28 | } 29 | 30 | for _, char := range name[1:] { 31 | if !strings.ContainsRune(validChars, char) { 32 | return fmt.Errorf("invalid character '%c'", char) 33 | } 34 | } 35 | 36 | return nil 37 | } 38 | 39 | func ValidatePackageNames(names []string) error { 40 | for _, name := range names { 41 | if err := ValidatePackageName(name); err != nil { 42 | return fmt.Errorf("'%s' is invalid: %w", name, err) 43 | } 44 | } 45 | 46 | return nil 47 | } 48 | -------------------------------------------------------------------------------- /internal/api/submit/client.go: -------------------------------------------------------------------------------- 1 | package submit 2 | 3 | import ( 4 | "bytes" 5 | "encoding/json" 6 | "fmt" 7 | "io" 8 | "net/http" 9 | "net/url" 10 | "time" 11 | 12 | "pkgstats-cli/internal/build" 13 | ) 14 | 15 | const timeout = 15 * time.Second 16 | 17 | type Client struct { 18 | Client *http.Client 19 | BaseURL string 20 | } 21 | 22 | func NewClient(baseURL string) *Client { 23 | httpClient := &http.Client{ 24 | Timeout: timeout, 25 | } 26 | 27 | return &Client{ 28 | Client: httpClient, 29 | BaseURL: baseURL, 30 | } 31 | } 32 | 33 | func (client *Client) SendRequest(request Request) error { 34 | payload, err := json.Marshal(request) 35 | if err != nil { 36 | return err 37 | } 38 | 39 | u, err := url.Parse(client.BaseURL) 40 | if err != nil { 41 | return err 42 | } 43 | u = u.JoinPath("/api/submit") 44 | 45 | req, err := http.NewRequest(http.MethodPost, u.String(), bytes.NewReader(payload)) 46 | if err != nil { 47 | return err 48 | } 49 | req.Header.Set("Content-Type", "application/json") 50 | req.Header.Set("Accept", "application/json") 51 | req.Header.Set("User-Agent", build.UserAgent) 52 | response, err := client.Client.Do(req) 53 | if err != nil { 54 | return err 55 | } 56 | 57 | defer response.Body.Close() 58 | 59 | if response.StatusCode != http.StatusNoContent { 60 | body, err := io.ReadAll(response.Body) 61 | if err != nil { 62 | return err 63 | } 64 | return fmt.Errorf("server error %d: %s", response.StatusCode, string(body)) 65 | } 66 | 67 | return nil 68 | } 69 | -------------------------------------------------------------------------------- /internal/api/submit/request.go: -------------------------------------------------------------------------------- 1 | package submit 2 | 3 | type System struct { 4 | Architecture string `json:"architecture"` 5 | } 6 | 7 | type OS struct { 8 | Architecture string `json:"architecture"` 9 | } 10 | 11 | type Pacman struct { 12 | Mirror string `json:"mirror"` 13 | Packages []string `json:"packages"` 14 | } 15 | 16 | type Request struct { 17 | Version string `json:"version"` 18 | System System `json:"system"` 19 | OS OS `json:"os"` 20 | Pacman Pacman `json:"pacman"` 21 | } 22 | 23 | const Version = "3" 24 | 25 | type PackageManager interface { 26 | GetInstalledPackages() ([]string, error) 27 | GetServer() (string, error) 28 | } 29 | 30 | type SystemInfo interface { 31 | GetCpuArchitecture() (string, error) 32 | GetArchitecture() (string, error) 33 | } 34 | 35 | func CreateRequest(p PackageManager, s SystemInfo) (*Request, error) { 36 | packages, err := p.GetInstalledPackages() 37 | if err != nil { 38 | return nil, err 39 | } 40 | mirror, err := p.GetServer() 41 | if err != nil { 42 | return nil, err 43 | } 44 | 45 | cpuArchitecture, err := s.GetCpuArchitecture() 46 | if err != nil { 47 | return nil, err 48 | } 49 | architecture, err := s.GetArchitecture() 50 | if err != nil { 51 | return nil, err 52 | } 53 | 54 | return &Request{ 55 | Version: Version, 56 | System: System{Architecture: cpuArchitecture}, 57 | OS: OS{Architecture: architecture}, 58 | Pacman: Pacman{Packages: packages, Mirror: mirror}, 59 | }, nil 60 | } 61 | -------------------------------------------------------------------------------- /internal/build/config.go: -------------------------------------------------------------------------------- 1 | package build 2 | 3 | var ( 4 | Version = "dev" 5 | UserAgent = "pkgstats/" + Version 6 | ) 7 | -------------------------------------------------------------------------------- /internal/pacman/config_map.go: -------------------------------------------------------------------------------- 1 | package pacman 2 | 3 | import "strings" 4 | 5 | type ( 6 | sectionMap map[string]string 7 | configMap map[string]sectionMap 8 | ) 9 | 10 | func newConfigMap() configMap { 11 | return make(configMap) 12 | } 13 | 14 | func (cm configMap) Get(section, key string) (string, bool) { 15 | if sec, ok := cm[section]; ok { 16 | if val, ok := sec[key]; ok { 17 | return val, true 18 | } 19 | } 20 | return "", false 21 | } 22 | 23 | func (cm configMap) Add(section, key, value string) { 24 | if _, ok := cm[section]; !ok { 25 | cm[section] = make(sectionMap) 26 | } 27 | if _, ok := cm[section][key]; !ok { 28 | cm[section][key] = value 29 | } 30 | } 31 | 32 | func createConfigMap(lines []string) configMap { 33 | cm := newConfigMap() 34 | var sectionName string 35 | const expectedParts = 2 36 | for _, line := range lines { 37 | line = strings.TrimSpace(line) 38 | if isSection(line) { 39 | sectionName = extractSectionName(line) 40 | continue 41 | } 42 | 43 | keyValuePair := strings.SplitN(line, "=", expectedParts) 44 | key := strings.TrimSpace(keyValuePair[0]) 45 | 46 | value := "" 47 | if len(keyValuePair) == expectedParts { 48 | value = strings.TrimSpace(keyValuePair[1]) 49 | } 50 | cm.Add(sectionName, key, value) 51 | } 52 | return cm 53 | } 54 | 55 | func isSection(line string) bool { 56 | return len(line) > 2 && strings.HasPrefix(line, "[") && strings.HasSuffix(line, "]") 57 | } 58 | 59 | func extractSectionName(line string) string { 60 | return line[1 : len(line)-1] 61 | } 62 | -------------------------------------------------------------------------------- /internal/pacman/packages.go: -------------------------------------------------------------------------------- 1 | package pacman 2 | 3 | import ( 4 | "fmt" 5 | "os" 6 | "path/filepath" 7 | ) 8 | 9 | func (p *Pacman) GetInstalledPackages() ([]string, error) { 10 | const verParts = 2 11 | 12 | db, err := os.Open(filepath.Join(p.config.dbPath, "local")) 13 | if err != nil { 14 | return nil, fmt.Errorf("failed to open pacman DB: %w", err) 15 | } 16 | defer db.Close() 17 | 18 | packages, err := db.Readdirnames(0) 19 | if err != nil { 20 | return nil, fmt.Errorf("failed to read package names: %w", err) 21 | } 22 | 23 | // Reuse the memory of packages 24 | filteredPackages := packages[:0] 25 | for _, pkg := range packages { 26 | hyphenCount := 0 27 | for j := len(pkg) - 1; j >= 0; j-- { 28 | if pkg[j] == '-' { 29 | hyphenCount++ 30 | if hyphenCount == verParts { 31 | filteredPackages = append(filteredPackages, pkg[:j]) 32 | break 33 | } 34 | } 35 | } 36 | } 37 | 38 | return filteredPackages, nil 39 | } 40 | -------------------------------------------------------------------------------- /internal/pacman/parser.go: -------------------------------------------------------------------------------- 1 | package pacman 2 | 3 | import ( 4 | "bufio" 5 | "errors" 6 | "fmt" 7 | "os" 8 | "path/filepath" 9 | "strings" 10 | ) 11 | 12 | const ( 13 | configMaxRecursion = 10 14 | repository = "core" 15 | defaultDBPath = "/var/lib/pacman" 16 | ) 17 | 18 | type config struct { 19 | dbPath string 20 | server string 21 | } 22 | 23 | type Pacman struct { 24 | config *config 25 | } 26 | 27 | type parser struct { 28 | includeFileCache map[string][]string 29 | } 30 | 31 | func Parse(pacmanConfPath string) (*Pacman, error) { 32 | conf, err := newParser().parseConfigFile(pacmanConfPath, defaultDBPath) 33 | if err != nil { 34 | return nil, err 35 | } 36 | 37 | return &Pacman{config: conf}, nil 38 | } 39 | 40 | func newParser() *parser { 41 | return &parser{ 42 | includeFileCache: make(map[string][]string), 43 | } 44 | } 45 | 46 | func (parser *parser) parseConfigFile(configPath string, defaultDBPath string) (*config, error) { 47 | lines, err := parser.readConfigFile(configPath, 0) 48 | if err != nil { 49 | return nil, err 50 | } 51 | 52 | confMap := createConfigMap(lines) 53 | 54 | dbPath, ok := confMap.Get("options", "DBPath") 55 | if !ok { 56 | dbPath = defaultDBPath 57 | } 58 | server, ok := confMap.Get(repository, "Server") 59 | if !ok { 60 | return nil, errors.New("server not found") 61 | } 62 | return &config{ 63 | dbPath: dbPath, 64 | server: server, 65 | }, nil 66 | } 67 | 68 | func (parser *parser) readConfigFile(fileName string, depth int) ([]string, error) { 69 | if depth >= configMaxRecursion { 70 | return nil, fmt.Errorf("reached maximum Include depth of %d", depth) 71 | } 72 | readFile, err := os.Open(fileName) 73 | if err != nil { 74 | return nil, err 75 | } 76 | defer readFile.Close() 77 | 78 | fileScanner := bufio.NewScanner(readFile) 79 | var fileLines []string 80 | for fileScanner.Scan() { 81 | line := strings.TrimSpace(fileScanner.Text()) 82 | if isCommentOrEmpty(line) { 83 | continue 84 | } 85 | if isIncludeLine(line) { 86 | includeLines, err := parser.processIncludeLine(line, depth+1) 87 | if err != nil { 88 | return nil, err 89 | } 90 | fileLines = append(fileLines, includeLines...) 91 | } else { 92 | fileLines = append(fileLines, line) 93 | } 94 | } 95 | if err := fileScanner.Err(); err != nil { 96 | return nil, err 97 | } 98 | return fileLines, nil 99 | } 100 | 101 | func (parser *parser) processIncludeLine(line string, depth int) ([]string, error) { 102 | const expectedParts = 2 103 | includeFileName := strings.TrimSpace(strings.SplitN(line, "=", expectedParts)[1]) 104 | includeFileNames, err := filepath.Glob(includeFileName) 105 | if err != nil { 106 | return nil, err 107 | } 108 | 109 | var allIncludedLines []string 110 | for _, fileName := range includeFileNames { 111 | if cachedLines, ok := parser.includeFileCache[fileName]; ok { 112 | allIncludedLines = append(allIncludedLines, cachedLines...) 113 | } else { 114 | includedLines, err := parser.readConfigFile(fileName, depth) 115 | if err != nil { 116 | return nil, err 117 | } 118 | parser.includeFileCache[fileName] = includedLines 119 | allIncludedLines = append(allIncludedLines, includedLines...) 120 | } 121 | } 122 | return allIncludedLines, nil 123 | } 124 | 125 | func isCommentOrEmpty(line string) bool { 126 | return line == "" || strings.HasPrefix(line, "#") 127 | } 128 | 129 | func isIncludeLine(line string) bool { 130 | return strings.HasPrefix(line, "Include") 131 | } 132 | -------------------------------------------------------------------------------- /internal/pacman/server.go: -------------------------------------------------------------------------------- 1 | package pacman 2 | 3 | import ( 4 | "fmt" 5 | "net/url" 6 | ) 7 | 8 | func (p *Pacman) GetServer() (string, error) { 9 | return NormalizeMirrorUrl(p.config.server) 10 | } 11 | 12 | func NormalizeMirrorUrl(mirror string) (string, error) { 13 | mirrorUrl, err := url.Parse(mirror) 14 | if err != nil { 15 | return "", err 16 | } 17 | 18 | if !mirrorUrl.IsAbs() { 19 | return "", fmt.Errorf("URL '%s' is not absolute", mirrorUrl.Redacted()) 20 | } 21 | 22 | // remove login information 23 | mirrorUrl.User = nil 24 | 25 | // strip the core/os/x86_64 path 26 | return mirrorUrl.JoinPath("../../../").Redacted(), nil 27 | } 28 | -------------------------------------------------------------------------------- /internal/system/system.go: -------------------------------------------------------------------------------- 1 | package system 2 | 3 | type System struct{} 4 | 5 | const ( 6 | AARCH64 = "aarch64" 7 | ARMV5 = "armv5" 8 | ARMV6 = "armv6" 9 | ARMV7 = "armv7" 10 | I586 = "i586" 11 | I686 = "i686" 12 | X86_64 = "x86_64" 13 | X86_64_V2 = "x86_64_v2" 14 | X86_64_V3 = "x86_64_v3" 15 | X86_64_V4 = "x86_64_v4" 16 | ) 17 | 18 | func NewSystem() *System { 19 | return &System{} 20 | } 21 | -------------------------------------------------------------------------------- /internal/system/system_386.go: -------------------------------------------------------------------------------- 1 | package system 2 | 3 | import ( 4 | "golang.org/x/sys/cpu" 5 | ) 6 | 7 | func (s *System) GetCpuArchitecture() (string, error) { 8 | // Check if we are on i686; otherwiese we know it is i586 with MMX as Go does require MMX instructions 9 | isI686 := hasCMOV() 10 | // We need to check for LM (Long Mode) as there are CPUs that support SSE2 but not x86_64 (e.g. Core Duo) 11 | isX86_64 := isI686 && hasLM() && cpu.X86.HasSSE2 12 | isX86_64V2 := isX86_64 && cpu.X86.HasPOPCNT && cpu.X86.HasSSE3 && cpu.X86.HasSSE41 && cpu.X86.HasSSE42 && cpu.X86.HasSSSE3 13 | isX86_64V3 := isX86_64V2 && cpu.X86.HasAVX && cpu.X86.HasAVX2 && cpu.X86.HasBMI1 && cpu.X86.HasBMI2 && cpu.X86.HasFMA && cpu.X86.HasOSXSAVE 14 | isX86_64V4 := isX86_64V3 && cpu.X86.HasAVX512F && cpu.X86.HasAVX512BW && cpu.X86.HasAVX512CD && cpu.X86.HasAVX512DQ && cpu.X86.HasAVX512VL 15 | 16 | switch { 17 | case isX86_64V4: 18 | return X86_64_V4, nil 19 | case isX86_64V3: 20 | return X86_64_V3, nil 21 | case isX86_64V2: 22 | return X86_64_V2, nil 23 | case isX86_64: 24 | return X86_64, nil 25 | case isI686: 26 | return I686, nil 27 | default: 28 | return I586, nil 29 | } 30 | } 31 | 32 | // Implemented at system_386.s 33 | func hasLM() bool 34 | func hasCMOV() bool 35 | -------------------------------------------------------------------------------- /internal/system/system_386.s: -------------------------------------------------------------------------------- 1 | #include "textflag.h" 2 | 3 | // func hasLM() bool 4 | TEXT ·hasLM(SB), NOSPLIT, $0-1 5 | MOVL $0x80000001, AX // Use extended function 0x80000001 6 | CPUID 7 | SHRL $29, DX // Shift right by 29 bits 8 | ANDL $1, DX // Isolate the 29th bit 9 | MOVB DX, ret+0(FP) // Move the result to the return value 10 | RET 11 | 12 | // func hasCMOV() bool 13 | TEXT ·hasCMOV(SB), NOSPLIT, $0-1 14 | MOVL $1, AX // Use standard function 1 15 | CPUID 16 | SHRL $15, DX // Shift right by 15 bits 17 | ANDL $1, DX // Isolate the 15th bit 18 | MOVB DX, ret+0(FP) // Move the result to the return value 19 | RET 20 | -------------------------------------------------------------------------------- /internal/system/system_amd64.go: -------------------------------------------------------------------------------- 1 | package system 2 | 3 | import ( 4 | "golang.org/x/sys/cpu" 5 | ) 6 | 7 | func (s *System) GetCpuArchitecture() (string, error) { 8 | // https://gitlab.com/x86-psABIs/x86-64-ABI/-/blob/master/x86-64-ABI/low-level-sys-info.tex 9 | // https://unix.stackexchange.com/questions/43539/what-do-the-flags-in-proc-cpuinfo-mean/43540#43540 10 | isX86_64V2 := cpu.X86.HasPOPCNT && cpu.X86.HasSSE3 && cpu.X86.HasSSE41 && cpu.X86.HasSSE42 && cpu.X86.HasSSSE3 11 | isX86_64V3 := isX86_64V2 && cpu.X86.HasAVX && cpu.X86.HasAVX2 && cpu.X86.HasBMI1 && cpu.X86.HasBMI2 && cpu.X86.HasFMA && cpu.X86.HasOSXSAVE 12 | isX86_64V4 := isX86_64V3 && cpu.X86.HasAVX512F && cpu.X86.HasAVX512BW && cpu.X86.HasAVX512CD && cpu.X86.HasAVX512DQ && cpu.X86.HasAVX512VL 13 | 14 | switch { 15 | case isX86_64V4: 16 | return X86_64_V4, nil 17 | case isX86_64V3: 18 | return X86_64_V3, nil 19 | case isX86_64V2: 20 | return X86_64_V2, nil 21 | default: 22 | return X86_64, nil 23 | } 24 | } 25 | -------------------------------------------------------------------------------- /internal/system/system_arm.go: -------------------------------------------------------------------------------- 1 | package system 2 | 3 | import ( 4 | . "golang.org/x/sys/cpu" 5 | ) 6 | 7 | func (s *System) GetCpuArchitecture() (string, error) { 8 | // https://github.com/lpereira/hardinfo/blob/master/modules/devices/arm/processor.c#L180 9 | // https://github.com/golang/go/issues/38987#issuecomment-626513091 10 | // https://community.arm.com/developer/tools-software/oss-platforms/b/android-blog/posts/runtime-detection-of-cpu-features-on-an-armv8-a-cpu 11 | // https://developer.arm.com/documentation/dui0471/m/key-features-of-arm-architecture-versions/arm-architecture-v7-a?lang=en 12 | // https://gcc.gnu.org/wiki/ARMv7 13 | // https://gcc.gnu.org/onlinedocs/gcc/ARM-Options.html 14 | switch { 15 | case ARM.HasPMULL || ARM.HasCRC32 || ARM.HasAES || ARM.HasSHA1 || ARM.HasSHA2: 16 | return AARCH64, nil 17 | case (ARM.HasVFPv3 && ARM.HasTHUMBEE) || (ARM.HasTHUMB && ARM.HasNEON): 18 | return ARMV7, nil 19 | case ARM.HasVFP && ARM.HasTHUMB: 20 | return ARMV6, nil 21 | default: 22 | return ARMV5, nil 23 | } 24 | } 25 | -------------------------------------------------------------------------------- /internal/system/system_arm64.go: -------------------------------------------------------------------------------- 1 | package system 2 | 3 | func (s *System) GetCpuArchitecture() (string, error) { 4 | return AARCH64, nil 5 | } 6 | -------------------------------------------------------------------------------- /internal/system/system_goarch.go: -------------------------------------------------------------------------------- 1 | //go:build !386 && !amd64 && !arm && !arm64 2 | 3 | package system 4 | 5 | import ( 6 | "runtime" 7 | ) 8 | 9 | func (s *System) GetCpuArchitecture() (string, error) { 10 | return runtime.GOARCH, nil 11 | } 12 | -------------------------------------------------------------------------------- /internal/system/system_goos.go: -------------------------------------------------------------------------------- 1 | //go:build !linux 2 | 3 | package system 4 | 5 | import ( 6 | "runtime" 7 | ) 8 | 9 | func (s *System) GetArchitecture() (string, error) { 10 | switch runtime.GOARCH { 11 | case "amd64": 12 | return X86_64, nil 13 | case "arm64": 14 | return AARCH64, nil 15 | default: 16 | return runtime.GOARCH, nil 17 | } 18 | } 19 | -------------------------------------------------------------------------------- /internal/system/system_linux.go: -------------------------------------------------------------------------------- 1 | package system 2 | 3 | import ( 4 | "bytes" 5 | 6 | "golang.org/x/sys/unix" 7 | ) 8 | 9 | func (s *System) GetArchitecture() (string, error) { 10 | var utsname unix.Utsname 11 | err := unix.Uname(&utsname) 12 | if err != nil { 13 | return "", err 14 | } 15 | 16 | return string(utsname.Machine[:bytes.IndexByte(utsname.Machine[:], 0)]), nil 17 | } 18 | -------------------------------------------------------------------------------- /just/aarch64.just: -------------------------------------------------------------------------------- 1 | test: 2 | #!/usr/bin/env bash 3 | set -euo pipefail 4 | cd ../ 5 | CGO_ENABLED=0 GOARCH=arm64 go test -exec qemu-aarch64 ./tests/... 6 | 7 | build: 8 | #!/usr/bin/env bash 9 | set -euo pipefail 10 | cd ../ 11 | CGO_ENABLED=0 GOARCH=arm64 go build -buildvcs=false -o /dev/null 12 | 13 | test-cpu-detection: 14 | #!/usr/bin/env bash 15 | set -euo pipefail 16 | cd ../ 17 | CGO_ENABLED=0 GOARCH=arm64 go run -exec 'qemu-aarch64' main.go architecture system | grep -q '^aarch64$' 18 | 19 | test-os-detection: 20 | #!/usr/bin/env bash 21 | set -euo pipefail 22 | cd ../ 23 | CGO_ENABLED=0 GOARCH=arm64 go run -exec 'qemu-aarch64' main.go architecture os | grep -q '^aarch64$' 24 | -------------------------------------------------------------------------------- /just/arm.just: -------------------------------------------------------------------------------- 1 | test: 2 | #!/usr/bin/env bash 3 | set -euo pipefail 4 | cd ../ 5 | CGO_ENABLED=0 GOARCH=arm GOARM=5 go test -exec 'qemu-arm -cpu pxa250' ./tests/... 6 | CGO_ENABLED=0 GOARCH=arm GOARM=6 go test -exec 'qemu-arm -cpu arm1176' ./tests/... 7 | CGO_ENABLED=0 GOARCH=arm GOARM=7 go test -exec 'qemu-arm -cpu cortex-a15' ./tests/... 8 | CGO_ENABLED=0 GOARCH=arm go test -exec 'qemu-arm -cpu max' ./tests/... 9 | 10 | build: 11 | #!/usr/bin/env bash 12 | set -euo pipefail 13 | cd ../ 14 | CGO_ENABLED=0 GOARCH=arm go build -buildvcs=false -o /dev/null 15 | 16 | test-cpu-detection: 17 | #!/usr/bin/env bash 18 | set -euo pipefail 19 | cd ../ 20 | CGO_ENABLED=0 GOARCH=arm GOARM=5 go run -exec 'qemu-arm -cpu pxa250' main.go architecture system | grep -q '^armv5$' 21 | CGO_ENABLED=0 GOARCH=arm GOARM=6 go run -exec 'qemu-arm -cpu arm1176' main.go architecture system | grep -q '^armv6$' 22 | CGO_ENABLED=0 GOARCH=arm GOARM=7 go run -exec 'qemu-arm -cpu cortex-a15' main.go architecture system | grep -q '^armv7$' 23 | CGO_ENABLED=0 GOARCH=arm go run -exec 'qemu-arm -cpu max' main.go architecture system | grep -q '^aarch64$' 24 | 25 | test-os-detection: 26 | #!/usr/bin/env bash 27 | set -euo pipefail 28 | cd ../ 29 | CGO_ENABLED=0 GOARCH=arm GOARM=5 go run -exec 'qemu-arm -cpu pxa250' main.go architecture os | grep -q '^armv5tel$' 30 | CGO_ENABLED=0 GOARCH=arm GOARM=6 go run -exec 'qemu-arm -cpu arm1176' main.go architecture os | grep -q '^armv6l$' 31 | CGO_ENABLED=0 GOARCH=arm GOARM=7 go run -exec 'qemu-arm -cpu cortex-a15' main.go architecture os | grep -q '^armv7l$' 32 | CGO_ENABLED=0 GOARCH=arm go run -exec 'qemu-arm -cpu max' main.go architecture os | grep -q '^armv7l$' 33 | -------------------------------------------------------------------------------- /just/dev.just: -------------------------------------------------------------------------------- 1 | mod aarch64 2 | mod arm 3 | mod i686 4 | mod loongarch64 5 | mod riscv64 6 | mod x86_64 7 | 8 | # update go modules 9 | update: 10 | sed -E '/^go\s+[0-9\.]+$/d' -i go.mod 11 | go get -u -t all 12 | go mod tidy 13 | sed -E 's/^go ([0-9]+\.[0-9]+)\.[0-9]+/go \1/' -i go.mod 14 | 15 | # run go vet 16 | check-vet: 17 | go vet ./... 18 | 19 | # run static code checks 20 | check-static: 21 | staticcheck ./... 22 | 23 | # run golangci-lint 24 | golangci-lint *args='run': 25 | golangci-lint {{ args }} 26 | 27 | # run gofumpt 28 | gofumpt *args='-w .': 29 | gofumpt {{ args }} 30 | 31 | # check go format 32 | check-fmt: 33 | test -z $(gofmt -l .) 34 | 35 | # run all static checks 36 | check: check-fmt check-vet check-static 37 | 38 | # run unit tests on different CPU architectures 39 | test-cross-platform: 40 | #!/usr/bin/env bash 41 | set -euo pipefail 42 | for a in aarch64 arm i686 loongarch64 riscv64 x86_64; do 43 | echo -n "$a "; just -v $a test 44 | done 45 | 46 | # build for different CPU architectures 47 | test-build: 48 | #!/usr/bin/env bash 49 | set -euo pipefail 50 | for a in aarch64 arm i686 loongarch64 riscv64 x86_64; do 51 | echo -n "$a "; just -v $a build 52 | done 53 | 54 | # test cpu architecture detection on different CPUs 55 | test-cpu-detection: 56 | #!/usr/bin/env bash 57 | set -euo pipefail 58 | for a in aarch64 arm i686 loongarch64 riscv64 x86_64; do 59 | echo -n "$a "; just -v $a test-cpu-detection 60 | done 61 | 62 | # test os architecture detection on different CPUs 63 | test-os-detection: 64 | #!/usr/bin/env bash 65 | set -euo pipefail 66 | for a in aarch64 arm i686 loongarch64 riscv64 x86_64; do 67 | echo -n "$a "; just -v $a test-os-detection 68 | done 69 | 70 | # run integration tests with a mocked API server 71 | test-integration: 72 | docker buildx build --pull . -f tests/integration/Dockerfile -t pkgstats-test-integration 73 | 74 | # run all available tests 75 | test-all: check golangci-lint test test-cross-platform test-build test-cpu-detection test-os-detection test-integration 76 | 77 | # remove any untracked and generated files 78 | clean: 79 | git clean -fdqx -e .idea 80 | 81 | coverage: 82 | #!/usr/bin/env bash 83 | set -euo pipefail 84 | COVER_FILE=$(mktemp) 85 | go test -coverprofile "$COVER_FILE" ./... 86 | go tool cover -html="$COVER_FILE" 87 | rm -f "$COVER_FILE" 88 | -------------------------------------------------------------------------------- /just/i686.just: -------------------------------------------------------------------------------- 1 | test: 2 | #!/usr/bin/env bash 3 | set -euo pipefail 4 | cd ../ 5 | CGO_ENABLED=0 GOARCH=386 GO386=softfloat go test -exec 'qemu-i386 -cpu pentium2' ./tests/... 6 | CGO_ENABLED=0 GOARCH=386 go test -exec 'qemu-i386 -cpu coreduo' ./tests/... 7 | # 32-Bit on x86_64 8 | CGO_ENABLED=0 GOARCH=386 go test -exec 'qemu-x86_64 /usr/bin/linux32' ./tests/... 9 | 10 | build: 11 | #!/usr/bin/env bash 12 | set -euo pipefail 13 | cd ../ 14 | CGO_ENABLED=0 GOARCH=386 go build -buildvcs=false -o /dev/null 15 | CGO_ENABLED=0 GOARCH=386 GO386=softfloat go build -buildvcs=false -o /dev/null 16 | 17 | test-cpu-detection: 18 | #!/usr/bin/env bash 19 | set -euo pipefail 20 | cd ../ 21 | CGO_ENABLED=0 GOARCH=386 GO386=softfloat go run -exec 'qemu-i386 -cpu pentium' main.go architecture system | grep -q '^i586$' 22 | CGO_ENABLED=0 GOARCH=386 GO386=softfloat go run -exec 'qemu-i386 -cpu pentium2' main.go architecture system | grep -q '^i686$' 23 | CGO_ENABLED=0 GOARCH=386 go run -exec 'qemu-i386 -cpu coreduo' main.go architecture system | grep -q '^i686$' 24 | # 32-Bit on x86_64 25 | CGO_ENABLED=0 GOARCH=386 go run -exec 'qemu-x86_64 /usr/bin/linux32' main.go architecture system | grep -q '^x86_64' 26 | 27 | test-os-detection: 28 | #!/usr/bin/env bash 29 | set -euo pipefail 30 | cd ../ 31 | CGO_ENABLED=0 GOARCH=386 GO386=softfloat go run -exec 'qemu-i386 -cpu pentium' main.go architecture os | grep -q '^i586$' 32 | CGO_ENABLED=0 GOARCH=386 GO386=softfloat go run -exec 'qemu-i386 -cpu pentium2' main.go architecture os | grep -q '^i686$' 33 | CGO_ENABLED=0 GOARCH=386 go run -exec 'qemu-i386 -cpu coreduo' main.go architecture os | grep -q '^i686$' 34 | # 32-Bit on x86_64 35 | CGO_ENABLED=0 GOARCH=386 go run -exec 'qemu-x86_64 /usr/bin/linux32' main.go architecture os | grep -q '^i686$' 36 | -------------------------------------------------------------------------------- /just/loongarch64.just: -------------------------------------------------------------------------------- 1 | test: 2 | #!/usr/bin/env bash 3 | set -euo pipefail 4 | cd ../ 5 | CGO_ENABLED=0 GOARCH=loong64 go test -exec qemu-loongarch64 ./tests/... 6 | 7 | build: 8 | #!/usr/bin/env bash 9 | set -euo pipefail 10 | cd ../ 11 | CGO_ENABLED=0 GOARCH=loong64 go build -buildvcs=false -o /dev/null 12 | 13 | test-cpu-detection: 14 | #!/usr/bin/env bash 15 | set -euo pipefail 16 | cd ../ 17 | CGO_ENABLED=0 GOARCH=loong64 go run -exec 'qemu-loongarch64' main.go architecture system | grep -q '^loong64$' 18 | 19 | test-os-detection: 20 | #!/usr/bin/env bash 21 | set -euo pipefail 22 | cd ../ 23 | CGO_ENABLED=0 GOARCH=loong64 go run -exec 'qemu-loongarch64' main.go architecture os | grep -q '^loongarch64$' 24 | -------------------------------------------------------------------------------- /just/riscv64.just: -------------------------------------------------------------------------------- 1 | test: 2 | #!/usr/bin/env bash 3 | set -euo pipefail 4 | cd ../ 5 | CGO_ENABLED=0 GOARCH=riscv64 go test -exec qemu-riscv64 ./tests/... 6 | 7 | build: 8 | #!/usr/bin/env bash 9 | set -euo pipefail 10 | cd ../ 11 | CGO_ENABLED=0 GOARCH=riscv64 go build -buildvcs=false -o /dev/null 12 | 13 | test-cpu-detection: 14 | #!/usr/bin/env bash 15 | set -euo pipefail 16 | cd ../ 17 | CGO_ENABLED=0 GOARCH=riscv64 go run -exec 'qemu-riscv64' main.go architecture system | grep -q '^riscv64$' 18 | 19 | test-os-detection: 20 | #!/usr/bin/env bash 21 | set -euo pipefail 22 | cd ../ 23 | CGO_ENABLED=0 GOARCH=riscv64 go run -exec 'qemu-riscv64' main.go architecture os | grep -q '^riscv64$' 24 | -------------------------------------------------------------------------------- /just/x86_64.just: -------------------------------------------------------------------------------- 1 | test: 2 | #!/usr/bin/env bash 3 | set -euo pipefail 4 | cd ../ 5 | CGO_ENABLED=0 GOARCH=amd64 go test -exec 'qemu-x86_64 -cpu Conroe' ./tests/... 6 | CGO_ENABLED=0 GOARCH=amd64 go test -exec 'qemu-x86_64 -cpu Nehalem' ./tests/... 7 | CGO_ENABLED=0 GOARCH=amd64 go test -exec 'qemu-x86_64 -cpu Haswell,-hle,-rtm' ./tests/... 8 | 9 | build: 10 | #!/usr/bin/env bash 11 | set -euo pipefail 12 | cd ../ 13 | CGO_ENABLED=0 GOARCH=amd64 go build -buildvcs=false -o /dev/null 14 | 15 | test-cpu-detection: 16 | #!/usr/bin/env bash 17 | set -euo pipefail 18 | cd ../ 19 | CGO_ENABLED=0 GOARCH=amd64 go run -exec 'qemu-x86_64 -cpu Conroe' main.go architecture system | grep -q '^x86_64$' 20 | CGO_ENABLED=0 GOARCH=amd64 go run -exec 'qemu-x86_64 -cpu Nehalem' main.go architecture system | grep -q '^x86_64_v2$' 21 | CGO_ENABLED=0 GOARCH=amd64 go run -exec 'qemu-x86_64 -cpu Haswell,-hle,-rtm' main.go architecture system | grep -q '^x86_64_v3$' 22 | 23 | test-os-detection: 24 | #!/usr/bin/env bash 25 | set -euo pipefail 26 | cd ../ 27 | CGO_ENABLED=0 GOARCH=amd64 go run -exec 'qemu-x86_64 -cpu Conroe' main.go architecture os | grep -q '^x86_64$' 28 | CGO_ENABLED=0 GOARCH=amd64 go run -exec 'qemu-x86_64 -cpu Nehalem' main.go architecture os | grep -q '^x86_64$' 29 | CGO_ENABLED=0 GOARCH=amd64 go run -exec 'qemu-x86_64 -cpu Haswell,-hle,-rtm' main.go architecture os | grep -q '^x86_64$' 30 | -------------------------------------------------------------------------------- /justfile: -------------------------------------------------------------------------------- 1 | import 'just/dev.just' 2 | 3 | export CGO_CPPFLAGS := env_var_or_default('CPPFLAGS', '') 4 | export CGO_CFLAGS := env_var_or_default('CFLAGS', '') 5 | export CGO_CXXFLAGS := env_var_or_default('CXXFLAGS', '') 6 | export CGO_LDFLAGS := env_var_or_default('LDFLAGS', '') 7 | 8 | # list all recipes 9 | default: 10 | @just --list 11 | 12 | # Prepare sources in order to build offline 13 | prepare: 14 | go mod download 15 | 16 | # build pkgstats for production 17 | build: 18 | go build -a -o pkgstats \ 19 | -buildmode=pie -mod=readonly -modcacherw -buildvcs=false \ 20 | -ldflags '-compressdwarf=false -linkmode=external -s -w -X pkgstats-cli/internal/build.Version={{ `git describe --tags` }}' 21 | 22 | # run unit tests 23 | test: 24 | go test ./tests/... 25 | 26 | # install pkgstats and its configuration 27 | install *DESTDIR='': 28 | #!/usr/bin/env bash 29 | set -euo pipefail 30 | 31 | # cli 32 | install -D pkgstats -m755 "{{ DESTDIR }}/usr/bin/pkgstats" 33 | 34 | # systemd timer 35 | for service in pkgstats.{service,timer}; do 36 | install -Dt "{{ DESTDIR }}/usr/lib/systemd/system" -m644 init/${service} 37 | done 38 | install -d "{{ DESTDIR }}/usr/lib/systemd/system/timers.target.wants" 39 | ln -s ../pkgstats.timer -t "{{ DESTDIR }}/usr/lib/systemd/system/timers.target.wants" 40 | 41 | # bash completions 42 | install -d "{{ DESTDIR }}/usr/share/bash-completion/completions" 43 | ./pkgstats completion bash > "{{ DESTDIR }}/usr/share/bash-completion/completions/pkgstats" 44 | 45 | # zsh completions 46 | install -d "{{ DESTDIR }}/usr/share/zsh/site-functions/" 47 | ./pkgstats completion zsh > "{{ DESTDIR }}/usr/share/zsh/site-functions/_pkgstats" 48 | 49 | # fish completions 50 | install -d "{{ DESTDIR }}/usr/share/fish/vendor_completions.d" 51 | ./pkgstats completion fish > "{{ DESTDIR }}/usr/share/fish/vendor_completions.d/pkgstats.fish" 52 | -------------------------------------------------------------------------------- /main.go: -------------------------------------------------------------------------------- 1 | package main 2 | 3 | import "pkgstats-cli/cmd" 4 | 5 | func main() { 6 | cmd.Execute() 7 | } 8 | -------------------------------------------------------------------------------- /tests/integration/Dockerfile: -------------------------------------------------------------------------------- 1 | FROM archlinux 2 | 3 | RUN pacman -Syu --noconfirm --cachedir /tmp/pacman-cache go just git gcc 4 | 5 | COPY . /app/ 6 | WORKDIR /app 7 | ENV INTEGRATION_TEST=1 8 | RUN just prepare 9 | RUN just build 10 | RUN just test 11 | RUN just install 12 | 13 | ENTRYPOINT ["/usr/bin/pkgstats"] 14 | -------------------------------------------------------------------------------- /tests/integration/integration_test.go: -------------------------------------------------------------------------------- 1 | package integration_test 2 | 3 | import ( 4 | "encoding/json" 5 | "fmt" 6 | "regexp" 7 | "slices" 8 | "strings" 9 | "testing" 10 | 11 | "pkgstats-cli/internal/api/submit" 12 | "pkgstats-cli/internal/system" 13 | ) 14 | 15 | func TestShowHelp(t *testing.T) { 16 | output, err := pkgstats(t, "help") 17 | if err != nil { 18 | t.Fatalf("Failed to run command: %v", err) 19 | } 20 | if !strings.Contains(output, "Usage:") { 21 | t.Errorf("Expected help output to contain 'Usage:', got %s", output) 22 | } 23 | } 24 | 25 | func TestShowVersion(t *testing.T) { 26 | output, err := pkgstats(t, "version") 27 | if err != nil { 28 | t.Fatalf("Failed to run command: %v", err) 29 | } 30 | if !strings.Contains(output, "version") { 31 | t.Errorf("Expected version output to contain 'version', got %s", output) 32 | } 33 | } 34 | 35 | func TestShowInformationToBeSent(t *testing.T) { 36 | s := system.NewSystem() 37 | osArchitecture, err := s.GetArchitecture() 38 | if err != nil { 39 | t.Fatal(err) 40 | } 41 | cpuArchitecture, err := s.GetCpuArchitecture() 42 | if err != nil { 43 | t.Fatal(err) 44 | } 45 | 46 | output, err := pkgstats(t, "submit", "--dump-json") 47 | if err != nil { 48 | t.Fatalf("Failed to run command: %v", err) 49 | } 50 | var request submit.Request 51 | if err := json.Unmarshal([]byte(output), &request); err != nil { 52 | t.Fatalf("Failed to unmarshal JSON: %v", err) 53 | } 54 | if request.Version != submit.Version { 55 | t.Errorf("Expected version %s, got %v", submit.Version, request.Version) 56 | } 57 | if request.System.Architecture != cpuArchitecture { 58 | t.Errorf("Expected system architecture '%s', got %v", cpuArchitecture, request.System.Architecture) 59 | } 60 | if request.OS.Architecture != osArchitecture { 61 | t.Errorf("Expected OS architecture '%s', got %v", osArchitecture, request.OS.Architecture) 62 | } 63 | if !strings.HasPrefix(request.Pacman.Mirror, "https://") { 64 | t.Errorf("Expected pacman mirror to start with 'https://', got %v", request.Pacman.Mirror) 65 | } 66 | if !slices.Contains(request.Pacman.Packages, "pacman-mirrorlist") { 67 | t.Errorf("Expected pacman packages to contain 'pacman-mirrorlist'") 68 | } 69 | } 70 | 71 | func TestSetQuietMode(t *testing.T) { 72 | output, err := pkgstats(t, "submit", "--quiet") 73 | if err != nil { 74 | t.Fatalf("Failed to run command: %v", err) 75 | } 76 | if len(output) != 0 { 77 | t.Errorf("Expected no output in quiet mode, got %s", output) 78 | } 79 | } 80 | 81 | func TestSetQuietModeAndDumpCannotBeUsedTogether(t *testing.T) { 82 | if _, err := pkgstats(t, "submit", "--dump-json", "--quiet"); err == nil { 83 | t.Fatal("Command should fail") 84 | } 85 | } 86 | 87 | func TestSendInformation(t *testing.T) { 88 | output, err := pkgstats(t, "submit") 89 | if err != nil { 90 | t.Fatalf("Failed to run command: %v", err) 91 | } 92 | lines := strings.Split(output, "\n") 93 | if !strings.Contains(lines[0], "Collecting data") { 94 | t.Errorf("Expected 'Collecting data', got %s", lines[0]) 95 | } 96 | if !strings.Contains(lines[1], "Submitting data") { 97 | t.Errorf("Expected 'Submitting data', got %s", lines[1]) 98 | } 99 | if !strings.Contains(lines[2], "Data were successfully sent") { 100 | t.Errorf("Expected 'Data were successfully sent', got %s", lines[2]) 101 | } 102 | } 103 | 104 | func linesContainsPackageStatistic(t *testing.T, lines []string, packages []string) { 105 | t.Helper() 106 | for _, e := range packages { 107 | matcher := regexp.MustCompile(fmt.Sprintf(`^%s\s+\d+\.\d+$`, regexp.QuoteMeta(e))) 108 | if !slices.ContainsFunc(lines, func(v string) bool { return matcher.MatchString(v) }) { 109 | t.Errorf("Expected to find '%s' in %v", e, lines) 110 | } 111 | } 112 | } 113 | 114 | func TestSearchPackages(t *testing.T) { 115 | output, err := pkgstats(t, "search", "php") 116 | if err != nil { 117 | t.Fatalf("Failed to run command: %v", err) 118 | } 119 | linesContainsPackageStatistic(t, strings.Split(output, "\n"), []string{"php", "php-fpm"}) 120 | } 121 | 122 | func TestShowPackages(t *testing.T) { 123 | output, err := pkgstats(t, "show", "php", "pacman") 124 | if err != nil { 125 | t.Fatalf("Failed to run command: %v", err) 126 | } 127 | linesContainsPackageStatistic(t, strings.Split(output, "\n"), []string{"php", "pacman"}) 128 | } 129 | 130 | func TestShowArchitecture(t *testing.T) { 131 | output, err := pkgstats(t, "architecture") 132 | if err != nil { 133 | t.Fatalf("Failed to run command: %v", err) 134 | } 135 | 136 | s := system.NewSystem() 137 | osArchitecture, err := s.GetArchitecture() 138 | if err != nil { 139 | t.Fatal(err) 140 | } 141 | cpuArchitecture, err := s.GetCpuArchitecture() 142 | if err != nil { 143 | t.Fatal(err) 144 | } 145 | 146 | if !strings.Contains(output, osArchitecture) || !strings.Contains(output, cpuArchitecture) { 147 | t.Fatalf("Expected OS and CPU architecture %s and %s, but got %s", osArchitecture, cpuArchitecture, strings.TrimSpace(output)) 148 | } 149 | } 150 | 151 | func TestShowOsArchitecture(t *testing.T) { 152 | output, err := pkgstats(t, "architecture", "os") 153 | if err != nil { 154 | t.Fatalf("Failed to run command: %v", err) 155 | } 156 | 157 | s := system.NewSystem() 158 | osArchitecture, err := s.GetArchitecture() 159 | if err != nil { 160 | t.Fatal(err) 161 | } 162 | 163 | if strings.TrimSpace(output) != osArchitecture { 164 | t.Fatalf("Expected OS architecture %s, but got %s", osArchitecture, strings.TrimSpace(output)) 165 | } 166 | } 167 | 168 | func TestShowSystemArchitecture(t *testing.T) { 169 | output, err := pkgstats(t, "architecture", "system") 170 | if err != nil { 171 | t.Fatalf("Failed to run command: %v", err) 172 | } 173 | 174 | s := system.NewSystem() 175 | cpuArchitecture, err := s.GetCpuArchitecture() 176 | if err != nil { 177 | t.Fatal(err) 178 | } 179 | 180 | if strings.TrimSpace(output) != cpuArchitecture { 181 | t.Fatalf("Expected CPU architecture %s, but got %s", cpuArchitecture, strings.TrimSpace(output)) 182 | } 183 | } 184 | -------------------------------------------------------------------------------- /tests/integration/mock_pacman_test.go: -------------------------------------------------------------------------------- 1 | package integration_test 2 | 3 | import ( 4 | "fmt" 5 | "os" 6 | "path/filepath" 7 | "testing" 8 | 9 | "pkgstats-cli/internal/system" 10 | ) 11 | 12 | func createPacmanConf(t *testing.T) string { 13 | t.Helper() 14 | 15 | s := system.NewSystem() 16 | osArchitecture, err := s.GetArchitecture() 17 | if err != nil { 18 | t.Fatal(err) 19 | } 20 | dbPath := createPacmanDBPath(t) 21 | 22 | pacmanConfFile := filepath.Join(t.TempDir(), "pacman.conf") 23 | if err := os.WriteFile(pacmanConfFile, fmt.Appendf(nil, "[options]\nDBPath=%s\n[core]\nServer=https://geo.mirror.pkgbuild.com/core/os/%s", dbPath, osArchitecture), 0o600); err != nil { 24 | t.Fatalf("Failed to create pacman.conf: %v", err) 25 | } 26 | 27 | return pacmanConfFile 28 | } 29 | 30 | func createPacmanDBPath(t *testing.T) string { 31 | t.Helper() 32 | 33 | dbPath := t.TempDir() 34 | localDir := filepath.Join(dbPath, "local") 35 | if err := os.Mkdir(localDir, 0o700); err != nil { 36 | t.Fatalf("Failed to create local directory: %v", err) 37 | } 38 | 39 | subdirs := []string{ 40 | "pacman-1.0-1", 41 | "pacman-mirrorlist-2.0-2", 42 | } 43 | 44 | for _, dir := range subdirs { 45 | subdirPath := filepath.Join(localDir, dir) 46 | err := os.Mkdir(subdirPath, 0o700) 47 | if err != nil { 48 | t.Fatalf("Failed to create subdirectory %s: %v", dir, err) 49 | } 50 | } 51 | 52 | return dbPath 53 | } 54 | -------------------------------------------------------------------------------- /tests/integration/mock_server_test.go: -------------------------------------------------------------------------------- 1 | package integration_test 2 | 3 | import ( 4 | "encoding/json" 5 | "fmt" 6 | "io" 7 | "net/http" 8 | "regexp" 9 | "slices" 10 | 11 | "pkgstats-cli/internal/api/request" 12 | "pkgstats-cli/internal/api/submit" 13 | "pkgstats-cli/internal/build" 14 | "pkgstats-cli/internal/system" 15 | ) 16 | 17 | type PackagePopularityListMock struct { 18 | request.PackagePopularityList 19 | } 20 | 21 | func NewPackagePopularityListMock() *PackagePopularityListMock { 22 | return &PackagePopularityListMock{ 23 | request.PackagePopularityList{ 24 | Total: 4, 25 | Count: 3, 26 | PackagePopularities: []request.PackagePopularity{ 27 | {Name: "php", Popularity: 56.78}, 28 | {Name: "php-fpm", Popularity: 12.34}, 29 | {Name: "pacman", Popularity: 10.78}, 30 | }, 31 | }, 32 | } 33 | } 34 | 35 | func (p *PackagePopularityListMock) getByName(name string) (request.PackagePopularity, error) { 36 | for _, pkg := range p.PackagePopularities { 37 | if pkg.Name == name { 38 | return pkg, nil 39 | } 40 | } 41 | return request.PackagePopularity{}, fmt.Errorf("package %s not found", name) 42 | } 43 | 44 | func NewServer() *http.ServeMux { 45 | mux := http.NewServeMux() 46 | mux.HandleFunc("POST /api/submit", handleSubmit) 47 | mux.HandleFunc("GET /api/packages", handlePackages) 48 | mux.HandleFunc("GET /api/packages/{package}", handlePackage) 49 | return mux 50 | } 51 | 52 | func handleSubmit(w http.ResponseWriter, r *http.Request) { 53 | if r.Header.Get("User-Agent") != build.UserAgent { 54 | http.Error(w, fmt.Sprintf("Invalid user agent %s", r.Header.Get("User-Agent")), http.StatusBadRequest) 55 | return 56 | } 57 | 58 | if r.URL.Query().Get("redirect") == "" { 59 | w.Header().Set("Location", "/api/submit?redirect=1") 60 | w.WriteHeader(http.StatusPermanentRedirect) 61 | return 62 | } 63 | 64 | body, err := io.ReadAll(r.Body) 65 | if err != nil { 66 | http.Error(w, err.Error(), http.StatusBadRequest) 67 | return 68 | } 69 | defer r.Body.Close() 70 | 71 | var request submit.Request 72 | if err := json.Unmarshal(body, &request); err != nil { 73 | http.Error(w, err.Error(), http.StatusBadRequest) 74 | return 75 | } 76 | 77 | validateSubmitRequest(w, &request) 78 | } 79 | 80 | func handlePackages(w http.ResponseWriter, r *http.Request) { 81 | w.Header().Set("Content-Type", "application/json") 82 | if err := json.NewEncoder(w).Encode(NewPackagePopularityListMock()); err != nil { 83 | http.Error(w, fmt.Sprintf("Error encoding response: %v", err), http.StatusInternalServerError) 84 | } 85 | } 86 | 87 | func handlePackage(w http.ResponseWriter, r *http.Request) { 88 | w.Header().Set("Content-Type", "application/json") 89 | p, err := NewPackagePopularityListMock().getByName(r.PathValue("package")) 90 | if err != nil { 91 | http.Error(w, fmt.Sprintf("Error fetching package: %v", err), http.StatusInternalServerError) 92 | return 93 | } 94 | if err := json.NewEncoder(w).Encode(p); err != nil { 95 | http.Error(w, fmt.Sprintf("Error encoding response: %v", err), http.StatusInternalServerError) 96 | } 97 | } 98 | 99 | func validateSubmitRequest(w http.ResponseWriter, request *submit.Request) { 100 | s := system.NewSystem() 101 | osArchitecture, err := s.GetArchitecture() 102 | if err != nil { 103 | http.Error(w, err.Error(), http.StatusInternalServerError) 104 | return 105 | } 106 | cpuArchitecture, err := s.GetCpuArchitecture() 107 | if err != nil { 108 | http.Error(w, err.Error(), http.StatusInternalServerError) 109 | return 110 | } 111 | 112 | if request.Version != submit.Version { 113 | http.Error(w, fmt.Sprintf("Expected version %s, got %s", submit.Version, request.Version), http.StatusBadRequest) 114 | return 115 | } 116 | if request.OS.Architecture != osArchitecture { 117 | http.Error(w, fmt.Sprintf("Expected OS architecture %s, got %s", osArchitecture, request.OS.Architecture), http.StatusBadRequest) 118 | return 119 | } 120 | if request.System.Architecture != cpuArchitecture { 121 | http.Error(w, fmt.Sprintf("Expected CPU architecture %s, got %s", cpuArchitecture, request.System.Architecture), http.StatusBadRequest) 122 | return 123 | } 124 | if !regexp.MustCompile(`^https?://.+$`).MatchString(request.Pacman.Mirror) { 125 | http.Error(w, fmt.Sprintf("Invalid HTTP mirror URL: %s", request.Pacman.Mirror), http.StatusBadRequest) 126 | return 127 | } 128 | if len(request.Pacman.Packages) <= 1 { 129 | http.Error(w, "Expected more than 1 package", http.StatusBadRequest) 130 | return 131 | } 132 | if !slices.Contains(request.Pacman.Packages, "pacman-mirrorlist") { 133 | http.Error(w, "Expected package list to contain pacman-mirrorlist", http.StatusBadRequest) 134 | return 135 | } 136 | 137 | w.WriteHeader(http.StatusNoContent) 138 | } 139 | -------------------------------------------------------------------------------- /tests/integration/pacman_test.go: -------------------------------------------------------------------------------- 1 | package integration_test 2 | 3 | import ( 4 | "net/url" 5 | "os" 6 | "os/exec" 7 | "slices" 8 | "strings" 9 | "testing" 10 | 11 | "pkgstats-cli/internal/pacman" 12 | ) 13 | 14 | func TestGetInstalledPackagesMatchesPacman(t *testing.T) { 15 | if _, err := exec.LookPath("pacman"); err != nil { 16 | const pacmanNotFoundMessage = "test requires pacman to be installed" 17 | if os.Getenv("INTEGRATION_TEST") == "1" { 18 | t.Fatal(pacmanNotFoundMessage) 19 | } else { 20 | t.Skip(pacmanNotFoundMessage) 21 | } 22 | } 23 | 24 | p, err := pacman.Parse("/etc/pacman.conf") 25 | if err != nil { 26 | t.Fatal(err) 27 | } 28 | parsedPackages, err := p.GetInstalledPackages() 29 | if err != nil { 30 | t.Fatal(err, parsedPackages) 31 | } 32 | 33 | cmd := exec.Command("pacman", "-Qq") 34 | out, err := cmd.Output() 35 | if err != nil { 36 | t.Fatal(err, out) 37 | } 38 | pacmanPackages := strings.Split(strings.TrimSpace(string(out)), "\n") 39 | 40 | slices.Sort(parsedPackages) 41 | slices.Sort(pacmanPackages) 42 | 43 | if slices.Compare(parsedPackages, pacmanPackages) != 0 { 44 | t.Fatalf("pacman and pkgstats disagree") 45 | } 46 | } 47 | 48 | func TestGetServerMatchesPacmanConf(t *testing.T) { 49 | if _, err := exec.LookPath("pacman-conf"); err != nil { 50 | const pacmanNotFoundMessage = "test requires pacman-conf to be installed" 51 | if os.Getenv("INTEGRATION_TEST") == "1" { 52 | t.Fatal(pacmanNotFoundMessage) 53 | } else { 54 | t.Skip(pacmanNotFoundMessage) 55 | } 56 | } 57 | 58 | p, err := pacman.Parse("/etc/pacman.conf") 59 | if err != nil { 60 | t.Fatal(err) 61 | } 62 | parsedServer, err := p.GetServer() 63 | if err != nil { 64 | t.Fatal(err, parsedServer) 65 | } 66 | parsedServerUrl, err := url.Parse(parsedServer) 67 | if err != nil { 68 | t.Fatal(err) 69 | } 70 | 71 | cmd := exec.Command("pacman-conf", "--repo=core", "Server") 72 | out, err := cmd.Output() 73 | if err != nil { 74 | t.Fatal(err, out) 75 | } 76 | pacmanConfServer := strings.Split(strings.TrimSpace(string(out)), "\n")[0] 77 | pacmanConfServerUrl, err := url.Parse(parsedServer) 78 | if err != nil { 79 | t.Fatal(err) 80 | } 81 | 82 | if parsedServerUrl.Redacted() != pacmanConfServerUrl.Redacted() { 83 | t.Fatalf("pacman-conf and pkgstats disagree: %s vs %s", pacmanConfServer, parsedServer) 84 | } 85 | } 86 | -------------------------------------------------------------------------------- /tests/integration/pkgstats_test.go: -------------------------------------------------------------------------------- 1 | package integration_test 2 | 3 | import ( 4 | "bytes" 5 | "net/http/httptest" 6 | "os" 7 | "testing" 8 | 9 | "pkgstats-cli/cmd" 10 | 11 | "github.com/spf13/cobra" 12 | "github.com/spf13/pflag" 13 | ) 14 | 15 | func pkgstats(t *testing.T, args ...string) (string, error) { 16 | t.Helper() 17 | 18 | rootCmd := cmd.GetRootCmd() 19 | defer resetFlags(t, rootCmd) 20 | 21 | server := httptest.NewServer(NewServer()) 22 | defer server.Close() 23 | 24 | args = append(args, "--base-url", server.URL) 25 | 26 | if os.Getenv("INTEGRATION_TEST") != "1" { 27 | args = append(args, "--pacman-conf", createPacmanConf(t)) 28 | } else { 29 | t.Log("Using actual pacman in integration test") 30 | } 31 | 32 | buf := new(bytes.Buffer) 33 | rootCmd.SetOut(buf) 34 | rootCmd.SetErr(buf) 35 | rootCmd.SetArgs(args) 36 | 37 | if err := rootCmd.Execute(); err != nil { 38 | return "", err 39 | } 40 | return buf.String(), nil 41 | } 42 | 43 | func resetFlags(t *testing.T, cmd *cobra.Command) { 44 | t.Helper() 45 | 46 | cmd.Flags().VisitAll(func(flag *pflag.Flag) { 47 | if err := flag.Value.Set(flag.DefValue); err != nil { 48 | t.Fatal(err) 49 | } 50 | }) 51 | for _, subCmd := range cmd.Commands() { 52 | resetFlags(t, subCmd) 53 | } 54 | } 55 | -------------------------------------------------------------------------------- /tests/integration/submit_request_bench_test.go: -------------------------------------------------------------------------------- 1 | package integration_test 2 | 3 | import ( 4 | "testing" 5 | 6 | "pkgstats-cli/internal/api/submit" 7 | "pkgstats-cli/internal/pacman" 8 | "pkgstats-cli/internal/system" 9 | ) 10 | 11 | func BenchmarkCreateRequest(b *testing.B) { 12 | for b.Loop() { 13 | p, err := pacman.Parse("/etc/pacman.conf") 14 | if err != nil { 15 | b.Errorf("Parsing pacman.conf failed: %v", err) 16 | } 17 | request, err := submit.CreateRequest(p, system.NewSystem()) 18 | if err != nil { 19 | b.Errorf("CreateRequest failed: %v", err) 20 | } 21 | _ = request // Use the request to avoid compiler optimizations 22 | } 23 | } 24 | -------------------------------------------------------------------------------- /tests/unit/internal/api/aubmit/client_test.go: -------------------------------------------------------------------------------- 1 | package submit_test 2 | 3 | import ( 4 | "encoding/json" 5 | "fmt" 6 | "io" 7 | "net/http" 8 | "net/http/httptest" 9 | "strings" 10 | "testing" 11 | 12 | "pkgstats-cli/internal/api/submit" 13 | "pkgstats-cli/internal/build" 14 | "pkgstats-cli/internal/system" 15 | ) 16 | 17 | const mirror = "https://geo.mirror.pkgbuild.com/" 18 | 19 | func TestSendRequest(t *testing.T) { 20 | server := httptest.NewServer(http.HandlerFunc(func(rw http.ResponseWriter, req *http.Request) { 21 | if req.URL.String() != "/api/submit" { 22 | t.Error("/api/submit was not called") 23 | } 24 | 25 | validateRequest(t, req) 26 | 27 | rw.WriteHeader(http.StatusNoContent) 28 | })) 29 | defer server.Close() 30 | 31 | client := submit.Client{Client: server.Client(), BaseURL: server.URL} 32 | request := &submit.Request{ 33 | Version: submit.Version, 34 | System: submit.System{Architecture: system.X86_64}, 35 | OS: submit.OS{Architecture: system.I686}, 36 | Pacman: submit.Pacman{Packages: []string{"pacman", "linux"}, Mirror: mirror}, 37 | } 38 | err := client.SendRequest(*request) 39 | if err != nil { 40 | t.Error(err) 41 | } 42 | } 43 | 44 | func validateRequest(t *testing.T, req *http.Request) { 45 | if req.Method != http.MethodPost { 46 | t.Error("Invalid Method", req.Method) 47 | } 48 | if req.Header.Get("Accept") != "application/json" { 49 | t.Error("Invalid Accept Header", req.Header.Get("Accept")) 50 | } 51 | if req.UserAgent() != build.UserAgent { 52 | t.Error("Invalid User-Agent", req.UserAgent()) 53 | } 54 | 55 | request := submit.Request{} 56 | body, err := io.ReadAll(req.Body) 57 | if err != nil { 58 | t.Errorf("Could not read request body %s", err) 59 | } 60 | err = json.Unmarshal(body, &request) 61 | if err != nil { 62 | t.Errorf("Could not decode JSON: %s", err) 63 | } 64 | 65 | if request.Version != submit.Version { 66 | t.Error("Invalid version value") 67 | } 68 | if strings.Join(request.Pacman.Packages, ",") != "pacman,linux" { 69 | t.Error("Invalid packages value") 70 | } 71 | if request.System.Architecture != system.X86_64 { 72 | t.Error("Invalid cpuarch value") 73 | } 74 | if request.OS.Architecture != system.I686 { 75 | t.Error("Invalid arch value") 76 | } 77 | if request.Pacman.Mirror != mirror { 78 | t.Error("Invalid mirror value") 79 | } 80 | } 81 | 82 | func TestSendRequestFollowsRedirect(t *testing.T) { 83 | server := httptest.NewServer(http.HandlerFunc(func(rw http.ResponseWriter, req *http.Request) { 84 | if req.URL.Query().Get("redirect") == "" { 85 | rw.Header().Add("Location", "/api/submit?redirect=1") 86 | rw.WriteHeader(http.StatusPermanentRedirect) 87 | 88 | return 89 | } 90 | if req.URL.String() != "/api/submit?redirect=1" { 91 | t.Error("/api/submit?redirect=1 was not called") 92 | } 93 | 94 | validateRequest(t, req) 95 | 96 | rw.WriteHeader(http.StatusNoContent) 97 | })) 98 | defer server.Close() 99 | 100 | client := submit.Client{Client: server.Client(), BaseURL: server.URL} 101 | request := &submit.Request{ 102 | Version: submit.Version, 103 | System: submit.System{Architecture: system.X86_64}, 104 | OS: submit.OS{Architecture: system.I686}, 105 | Pacman: submit.Pacman{Packages: []string{"pacman", "linux"}, Mirror: mirror}, 106 | } 107 | err := client.SendRequest(*request) 108 | if err != nil { 109 | t.Error(err) 110 | } 111 | } 112 | 113 | func TestReturnServerErrorOnFailure(t *testing.T) { 114 | const errorMessage = "Expected server failure" 115 | server := httptest.NewServer(http.HandlerFunc(func(rw http.ResponseWriter, req *http.Request) { 116 | if req.URL.String() != "/api/submit" { 117 | t.Error("/api/submit was not called") 118 | } 119 | 120 | validateRequest(t, req) 121 | 122 | rw.WriteHeader(http.StatusBadRequest) 123 | fmt.Fprint(rw, errorMessage) 124 | })) 125 | defer server.Close() 126 | 127 | client := submit.Client{Client: server.Client(), BaseURL: server.URL} 128 | request := &submit.Request{ 129 | Version: submit.Version, 130 | System: submit.System{Architecture: system.X86_64}, 131 | OS: submit.OS{Architecture: system.I686}, 132 | Pacman: submit.Pacman{Packages: []string{"pacman", "linux"}, Mirror: mirror}, 133 | } 134 | err := client.SendRequest(*request) 135 | if err != nil && !strings.Contains(err.Error(), errorMessage) { 136 | t.Errorf("Expected failed request, got %v", err) 137 | } 138 | } 139 | -------------------------------------------------------------------------------- /tests/unit/internal/api/request/client_test.go: -------------------------------------------------------------------------------- 1 | package request_test 2 | 3 | import ( 4 | "fmt" 5 | "net/http" 6 | "net/http/httptest" 7 | "strings" 8 | "testing" 9 | 10 | "pkgstats-cli/internal/api/request" 11 | ) 12 | 13 | func TestGetPackages(t *testing.T) { 14 | server := httptest.NewServer(http.HandlerFunc(func(rw http.ResponseWriter, req *http.Request) { 15 | if !strings.HasPrefix(req.URL.String(), "/api/packages/") { 16 | t.Error("/api/packages/ was not called") 17 | } 18 | fmt.Fprint(rw, "{}") 19 | })) 20 | defer server.Close() 21 | 22 | client := request.Client{Client: server.Client(), BaseURL: server.URL} 23 | _, err := client.GetPackages("foo", "bar") 24 | if err != nil { 25 | t.Error(err) 26 | } 27 | } 28 | 29 | func TestGetPackage(t *testing.T) { 30 | server := httptest.NewServer(http.HandlerFunc(func(rw http.ResponseWriter, req *http.Request) { 31 | if req.URL.String() != "/api/packages/foo" { 32 | t.Error("/api/packages/foo was not called") 33 | } 34 | fmt.Fprint(rw, "{}") 35 | })) 36 | defer server.Close() 37 | 38 | client := request.Client{Client: server.Client(), BaseURL: server.URL} 39 | _, err := client.GetPackage("foo") 40 | if err != nil { 41 | t.Error(err) 42 | } 43 | } 44 | 45 | func TestSearchPackages(t *testing.T) { 46 | server := httptest.NewServer(http.HandlerFunc(func(rw http.ResponseWriter, req *http.Request) { 47 | if req.URL.String() != "/api/packages?limit=1&query=foo" { 48 | t.Error("/api/packages?limit=1&query=foo was not called") 49 | } 50 | fmt.Fprint(rw, "{}") 51 | })) 52 | defer server.Close() 53 | 54 | client := request.Client{Client: server.Client(), BaseURL: server.URL} 55 | _, err := client.SearchPackages("foo", 1) 56 | if err != nil { 57 | t.Error(err) 58 | } 59 | } 60 | 61 | func TestHandleServerError(t *testing.T) { 62 | server := httptest.NewServer(http.HandlerFunc(func(rw http.ResponseWriter, req *http.Request) { 63 | rw.WriteHeader(http.StatusBadRequest) 64 | fmt.Fprint(rw, "Ignored server message") 65 | })) 66 | defer server.Close() 67 | 68 | client := request.Client{Client: server.Client(), BaseURL: server.URL} 69 | _, err := client.GetPackages("foo") 70 | if err != nil && err.Error() != "Bad Request" { 71 | t.Errorf("Expected Bad Request, got %v", err) 72 | } 73 | } 74 | -------------------------------------------------------------------------------- /tests/unit/internal/api/request/printer_test.go: -------------------------------------------------------------------------------- 1 | package request_test 2 | 3 | import ( 4 | "bytes" 5 | "regexp" 6 | "testing" 7 | 8 | "pkgstats-cli/internal/api/request" 9 | ) 10 | 11 | func TestPrintPackagePopularities(t *testing.T) { 12 | var buffer bytes.Buffer 13 | request.PrintPackagePopularities(&buffer, request.PackagePopularityList{Total: 1, Count: 1, PackagePopularities: []request.PackagePopularity{{Name: "foo", Popularity: 12.34}}}) 14 | 15 | output := buffer.String() 16 | 17 | if !regexp.MustCompile(`^foo\s+12.34\s+1 of 1 results\s+$`).MatchString(output) { 18 | t.Errorf("Unexpected output %s", output) 19 | } 20 | } 21 | 22 | func TestPrintSearchURL(t *testing.T) { 23 | var buffer bytes.Buffer 24 | request.PrintSearchURL(&buffer, "/foo", "bar") 25 | 26 | output := buffer.String() 27 | 28 | if !regexp.MustCompile(`\s+/foo/packages#query=bar\s+`).MatchString(output) { 29 | t.Errorf("Unexpected output %s", output) 30 | } 31 | } 32 | 33 | func TestPrintShowURL(t *testing.T) { 34 | var buffer bytes.Buffer 35 | request.PrintShowURL(&buffer, "/foo", []string{"bar", "baz"}) 36 | 37 | output := buffer.String() 38 | 39 | if !regexp.MustCompile(`\s+/foo/compare/packages#packages=bar,baz\s+`).MatchString(output) { 40 | t.Errorf("Unexpected output %s", output) 41 | } 42 | } 43 | -------------------------------------------------------------------------------- /tests/unit/internal/api/request/validator_test.go: -------------------------------------------------------------------------------- 1 | package request_test 2 | 3 | import ( 4 | "testing" 5 | 6 | "pkgstats-cli/internal/api/request" 7 | ) 8 | 9 | var ( 10 | validPackageNames = []string{"pacman", "@pacman", "_pacman", "+pacman", "pacman-contrib", "pacman_foo", "pacman@7", "pacman+bar", "pacman.bar"} 11 | invalidPackageNames = []string{"-pacman", ".pacman", "ö", "", "pacman-ö", "🐱", "🐱nip"} 12 | ) 13 | 14 | func TestValidPackageName(t *testing.T) { 15 | for _, name := range validPackageNames { 16 | if err := request.ValidatePackageName(name); err != nil { 17 | t.Error("name should be valid:", name, err) 18 | } 19 | } 20 | } 21 | 22 | func TestInvalidPackageName(t *testing.T) { 23 | for _, name := range invalidPackageNames { 24 | if err := request.ValidatePackageName(name); err == nil { 25 | t.Error("name should be invalid") 26 | } 27 | } 28 | } 29 | 30 | func TestValidPackageNames(t *testing.T) { 31 | for _, name := range validPackageNames { 32 | if err := request.ValidatePackageNames(append([]string{"foo"}, name)); err != nil { 33 | t.Error("names should be valid", name, err) 34 | } 35 | } 36 | } 37 | 38 | func TestInvalidPackageNames(t *testing.T) { 39 | for _, name := range invalidPackageNames { 40 | if err := request.ValidatePackageNames(append([]string{"foo"}, name)); err == nil { 41 | t.Error("names should be invalid") 42 | } 43 | } 44 | } 45 | -------------------------------------------------------------------------------- /tests/unit/internal/build/version_test.go: -------------------------------------------------------------------------------- 1 | package build_test 2 | 3 | import ( 4 | "testing" 5 | 6 | "pkgstats-cli/internal/build" 7 | ) 8 | 9 | func TestVersion(t *testing.T) { 10 | if build.Version != "dev" { 11 | t.Error("Version is not defined") 12 | } 13 | } 14 | -------------------------------------------------------------------------------- /tests/unit/internal/pacman/pacman_test.go: -------------------------------------------------------------------------------- 1 | package pacman_test 2 | 3 | import ( 4 | "fmt" 5 | "os" 6 | "path/filepath" 7 | "slices" 8 | "strings" 9 | "testing" 10 | 11 | "pkgstats-cli/internal/pacman" 12 | ) 13 | 14 | const ( 15 | SERVER = "https://mirror.rackspace.com/archlinux/" 16 | MIRROR = SERVER + "core/os/x86_64" 17 | ) 18 | 19 | func createPacmanDb(t *testing.T, packages []string) string { 20 | t.Helper() 21 | 22 | dbPath := t.TempDir() 23 | localDir := filepath.Join(dbPath, "local") 24 | if err := os.Mkdir(localDir, 0o700); err != nil { 25 | t.Fatalf("Failed to create local directory: %v", err) 26 | } 27 | 28 | for _, dir := range packages { 29 | if err := os.Mkdir(filepath.Join(localDir, dir), 0o700); err != nil { 30 | t.Fatalf("Failed to create subdirectory %s: %v", dir, err) 31 | } 32 | } 33 | 34 | return dbPath 35 | } 36 | 37 | func createPacmanConf(t *testing.T, dbPath string, servers []string) string { 38 | t.Helper() 39 | 40 | pacmanConfFile := filepath.Join(t.TempDir(), "pacman.conf") 41 | 42 | var conf strings.Builder 43 | if dbPath != "" { 44 | conf.WriteString(fmt.Sprintf("[options]\nDBPath=%s\n", dbPath)) 45 | } 46 | 47 | if len(servers) > 0 { 48 | conf.WriteString("[core]\n") 49 | for _, server := range servers { 50 | conf.WriteString(fmt.Sprintf("Server=%s\n", server)) 51 | } 52 | } 53 | 54 | if err := os.WriteFile(pacmanConfFile, []byte(conf.String()), 0o600); err != nil { 55 | t.Fatalf("Failed to create pacman.conf: %v", err) 56 | } 57 | 58 | return pacmanConfFile 59 | } 60 | 61 | func TestGetInstalledPackages(t *testing.T) { 62 | dbPath := createPacmanDb(t, []string{"pacman-1.0-1", "go-2.0-2", "php-fpm-8-8.3-32"}) 63 | pacmanConfFile := createPacmanConf(t, dbPath, []string{MIRROR}) 64 | 65 | p, err := pacman.Parse(pacmanConfFile) 66 | if err != nil { 67 | t.Fatal(err) 68 | } 69 | out, err := p.GetInstalledPackages() 70 | if err != nil { 71 | t.Fatal(err, out) 72 | } 73 | 74 | for _, p := range []string{"pacman", "go", "php-fpm-8"} { 75 | if !slices.Contains(out, p) { 76 | t.Errorf("could not find package %s in %v", p, out) 77 | } 78 | } 79 | } 80 | 81 | func TestGetServer(t *testing.T) { 82 | pacmanConfFile := createPacmanConf(t, "", []string{MIRROR, "https://geo.mirror.pkgbuild.com/core/os/x86_64"}) 83 | 84 | p, err := pacman.Parse(pacmanConfFile) 85 | if err != nil { 86 | t.Fatal(err) 87 | } 88 | out, err := p.GetServer() 89 | if err != nil { 90 | t.Fatal(err, out) 91 | } 92 | if out != SERVER { 93 | t.Error(out) 94 | } 95 | } 96 | 97 | func TestPacmanConfIncludes(t *testing.T) { 98 | pacmanConfFile := filepath.Join(t.TempDir(), "pacman.conf") 99 | pacmanConfFileInclude1 := filepath.Join(t.TempDir(), "pacman-include1.conf") 100 | pacmanConfFileInclude2 := filepath.Join(t.TempDir(), "pacman-include2.conf") 101 | 102 | if err := os.WriteFile(pacmanConfFile, fmt.Appendf(nil, "[core]\nInclude=%s\n", pacmanConfFileInclude1), 0o600); err != nil { 103 | t.Fatalf("Failed to create pacman.conf: %v", err) 104 | } 105 | if err := os.WriteFile(pacmanConfFileInclude1, fmt.Appendf(nil, "Include=%s\nInclude=%s\n", pacmanConfFileInclude2, pacmanConfFileInclude2), 0o600); err != nil { 106 | t.Fatalf("Failed to create pacman.conf: %v", err) 107 | } 108 | if err := os.WriteFile(pacmanConfFileInclude2, fmt.Appendf(nil, "Server=%s\n", MIRROR), 0o600); err != nil { 109 | t.Fatalf("Failed to create pacman.conf: %v", err) 110 | } 111 | 112 | p, err := pacman.Parse(pacmanConfFile) 113 | if err != nil { 114 | t.Fatal(err) 115 | } 116 | out, err := p.GetServer() 117 | if err != nil { 118 | t.Fatal(err, out) 119 | } 120 | if out != SERVER { 121 | t.Error(out) 122 | } 123 | } 124 | 125 | func TestPacmanConfIncludesGlob(t *testing.T) { 126 | pacmanConfFile := filepath.Join(t.TempDir(), "pacman.conf") 127 | d := t.TempDir() 128 | pacmanConfFileInclude1 := filepath.Join(d, "pacman-include1.conf") 129 | pacmanConfFileInclude2 := filepath.Join(d, "pacman-include2.conf") 130 | 131 | if err := os.WriteFile(pacmanConfFile, fmt.Appendf(nil, "[core]\nInclude=%s/pacman-*.conf\n", d), 0o600); err != nil { 132 | t.Fatalf("Failed to create pacman.conf: %v", err) 133 | } 134 | if err := os.WriteFile(pacmanConfFileInclude1, []byte(""), 0o600); err != nil { 135 | t.Fatalf("Failed to create pacman.conf: %v", err) 136 | } 137 | if err := os.WriteFile(pacmanConfFileInclude2, fmt.Appendf(nil, "Server=%s\n", MIRROR), 0o600); err != nil { 138 | t.Fatalf("Failed to create pacman.conf: %v", err) 139 | } 140 | 141 | p, err := pacman.Parse(pacmanConfFile) 142 | if err != nil { 143 | t.Fatal(err) 144 | } 145 | out, err := p.GetServer() 146 | if err != nil { 147 | t.Fatal(err, out) 148 | } 149 | if out != SERVER { 150 | t.Error(out) 151 | } 152 | } 153 | 154 | func TestPacmanConfComments(t *testing.T) { 155 | pacmanConfFile := filepath.Join(t.TempDir(), "pacman.conf") 156 | if err := os.WriteFile(pacmanConfFile, fmt.Appendf(nil, "[core]\n#Server=invalid\nServer=%s\n", MIRROR), 0o600); err != nil { 157 | t.Fatalf("Failed to create pacman.conf: %v", err) 158 | } 159 | 160 | p, err := pacman.Parse(pacmanConfFile) 161 | if err != nil { 162 | t.Fatal(err) 163 | } 164 | s, err := p.GetServer() 165 | if err != nil || s != SERVER { 166 | t.Fatal(err, s) 167 | } 168 | } 169 | 170 | func TestPacmanConfEmptySections(t *testing.T) { 171 | pacmanConfFile := filepath.Join(t.TempDir(), "pacman.conf") 172 | if err := os.WriteFile(pacmanConfFile, fmt.Appendf(nil, "[]\n[core]\nServer=%s\n", MIRROR), 0o600); err != nil { 173 | t.Fatalf("Failed to create pacman.conf: %v", err) 174 | } 175 | 176 | p, err := pacman.Parse(pacmanConfFile) 177 | if err != nil { 178 | t.Fatal(err) 179 | } 180 | s, err := p.GetServer() 181 | if err != nil || s != SERVER { 182 | t.Fatal(err, s) 183 | } 184 | } 185 | 186 | func TestNormalizeMirrorUrl(t *testing.T) { 187 | tests := []struct { 188 | input string 189 | expected string 190 | hasError bool 191 | }{ 192 | // Valid inputs 193 | {"http://example.com/path/to/mirror", "http://example.com/", false}, 194 | {"ftp://example.com/path/to/mirror", "ftp://example.com/", false}, 195 | {"rsync://example.com/path/to/mirror", "rsync://example.com/", false}, 196 | {"https://example.com/path/to/mirror", "https://example.com/", false}, 197 | {"http://example.com/path/to/mirror/", "http://example.com/", false}, 198 | {"https://example.com:8080/path/to/mirror", "https://example.com:8080/", false}, 199 | {"ftp://example.com/path/to/mirror", "ftp://example.com/", false}, 200 | {"ftp://example.com/path/to", "ftp://example.com/", false}, 201 | {"ftp://example.com/path/", "ftp://example.com/", false}, 202 | {"ftp://example.com/path", "ftp://example.com/", false}, 203 | {"ftp://example.com/", "ftp://example.com/", false}, 204 | {"ftp://example.com", "ftp://example.com/", false}, 205 | {"http://example.com/path/to/mirror/", "http://example.com/", false}, 206 | {"http://example.com/path/to/mirror/extra", "http://example.com/path/", false}, 207 | {"http://example.com", "http://example.com/", false}, 208 | {"http://user:password@example.com", "http://example.com/", false}, 209 | {"http://user@example.com", "http://example.com/", false}, 210 | {"http://example.com:1234/", "http://example.com:1234/", false}, 211 | {"file:///foo", "file:///", false}, 212 | {"file:///mnt/mirror/core/os/x86_64", "file:///mnt/mirror/", false}, 213 | 214 | // Invalid inputs 215 | {"", "", true}, 216 | {"/", "", true}, 217 | {"://example.com/path/to/mirror", "", true}, 218 | {"http://example.com:invalidport/path/to/mirror", "", true}, 219 | } 220 | 221 | for _, test := range tests { 222 | result, err := pacman.NormalizeMirrorUrl(test.input) 223 | if (err != nil) != test.hasError { 224 | t.Errorf("NormalizeMirrorUrl(%q) error = %v, wantErr %v", test.input, err, test.hasError) 225 | continue 226 | } 227 | if result != test.expected { 228 | t.Errorf("NormalizeMirrorUrl(%q) = %v, want %v", test.input, result, test.expected) 229 | } 230 | } 231 | } 232 | -------------------------------------------------------------------------------- /tests/unit/internal/system/system_386_test.go: -------------------------------------------------------------------------------- 1 | package system_test 2 | 3 | import ( 4 | "slices" 5 | "testing" 6 | 7 | "pkgstats-cli/internal/system" 8 | ) 9 | 10 | func TestGetCpuArchitecture(t *testing.T) { 11 | cpuArch, err := system.NewSystem().GetCpuArchitecture() 12 | if err != nil { 13 | t.Error(err) 14 | } 15 | if !slices.Contains([]string{system.I586, system.I686, system.X86_64, system.X86_64_V2, system.X86_64_V3, system.X86_64_V4}, cpuArch) { 16 | t.Error(cpuArch) 17 | } 18 | } 19 | -------------------------------------------------------------------------------- /tests/unit/internal/system/system_amd64_test.go: -------------------------------------------------------------------------------- 1 | package system_test 2 | 3 | import ( 4 | "slices" 5 | "testing" 6 | 7 | "pkgstats-cli/internal/system" 8 | ) 9 | 10 | func TestGetCpuArchitecture(t *testing.T) { 11 | cpuArch, err := system.NewSystem().GetCpuArchitecture() 12 | if err != nil { 13 | t.Error(err) 14 | } 15 | if !slices.Contains([]string{system.X86_64, system.X86_64_V2, system.X86_64_V3, system.X86_64_V4}, cpuArch) { 16 | t.Error(cpuArch) 17 | } 18 | } 19 | -------------------------------------------------------------------------------- /tests/unit/internal/system/system_arm64_test.go: -------------------------------------------------------------------------------- 1 | package system_test 2 | 3 | import ( 4 | "testing" 5 | 6 | "pkgstats-cli/internal/system" 7 | ) 8 | 9 | func TestGetCpuArchitecture(t *testing.T) { 10 | cpuArch, err := system.NewSystem().GetCpuArchitecture() 11 | if err != nil { 12 | t.Error(err) 13 | } 14 | if cpuArch != system.AARCH64 { 15 | t.Error(cpuArch) 16 | } 17 | } 18 | -------------------------------------------------------------------------------- /tests/unit/internal/system/system_arm_test.go: -------------------------------------------------------------------------------- 1 | package system_test 2 | 3 | import ( 4 | "slices" 5 | "testing" 6 | 7 | "pkgstats-cli/internal/system" 8 | ) 9 | 10 | func TestGetCpuArchitecture(t *testing.T) { 11 | cpuArch, err := system.NewSystem().GetCpuArchitecture() 12 | if err != nil { 13 | t.Error(err) 14 | } 15 | if !slices.Contains([]string{system.ARMV5, system.ARMV6, system.ARMV7, system.AARCH64}, cpuArch) { 16 | t.Error(cpuArch) 17 | } 18 | } 19 | -------------------------------------------------------------------------------- /tests/unit/internal/system/system_goarch_test.go: -------------------------------------------------------------------------------- 1 | //go:build !386 && !amd64 && !arm && !arm64 2 | 3 | package system_test 4 | 5 | import ( 6 | "runtime" 7 | "testing" 8 | 9 | "pkgstats-cli/internal/system" 10 | ) 11 | 12 | func TestGetCpuArchitecture(t *testing.T) { 13 | cpuArch, err := system.NewSystem().GetCpuArchitecture() 14 | if err != nil { 15 | t.Error(err) 16 | } 17 | if cpuArch != runtime.GOARCH { 18 | t.Error(cpuArch) 19 | } 20 | } 21 | -------------------------------------------------------------------------------- /tests/unit/internal/system/system_goos_test.go: -------------------------------------------------------------------------------- 1 | //go:build !linux 2 | 3 | package system_test 4 | 5 | import ( 6 | "runtime" 7 | "testing" 8 | 9 | "pkgstats-cli/internal/system" 10 | ) 11 | 12 | func TestGetArchitecture(t *testing.T) { 13 | cpuArch, err := system.NewSystem().GetCpuArchitecture() 14 | if err != nil { 15 | t.Error(err) 16 | } 17 | if cpuArch != runtime.GOARCH { 18 | t.Error(cpuArch) 19 | } 20 | } 21 | -------------------------------------------------------------------------------- /tests/unit/internal/system/system_linux_test.go: -------------------------------------------------------------------------------- 1 | package system_test 2 | 3 | import ( 4 | "runtime" 5 | "slices" 6 | "strings" 7 | "testing" 8 | 9 | "pkgstats-cli/internal/system" 10 | ) 11 | 12 | func TestGetMachine(t *testing.T) { 13 | arch, err := system.NewSystem().GetArchitecture() 14 | 15 | expectedArch := func(arch string) bool { return arch == runtime.GOARCH } 16 | switch runtime.GOARCH { 17 | case "amd64": 18 | expectedArch = func(arch string) bool { return strings.HasPrefix(arch, system.X86_64) } 19 | case "386": 20 | expectedArch = func(arch string) bool { return slices.Contains([]string{system.I586, system.I686}, arch) } 21 | case "arm": 22 | expectedArch = func(arch string) bool { return strings.HasPrefix(arch, "armv") } 23 | case "arm64": 24 | expectedArch = func(arch string) bool { return arch == system.AARCH64 } 25 | case "loong64": 26 | expectedArch = func(arch string) bool { return arch == "loongarch64" } 27 | } 28 | 29 | if err != nil { 30 | t.Error(err) 31 | } 32 | if !expectedArch(arch) { 33 | t.Error(arch) 34 | } 35 | } 36 | --------------------------------------------------------------------------------