├── .codeclimate.yml ├── .dockerignore ├── .gitignore ├── .gitmodules ├── .local └── .gitkeep ├── .travis.yml ├── LICENSE ├── Makefile ├── README.md ├── Setup.hs ├── app ├── CLI.hs └── Main.hs ├── codeclimate-shellcheck.cabal ├── data ├── env.yml └── prepare.rb ├── docker ├── Build.plan ├── Release.plan └── files │ ├── glibc-2.23-r1.apk │ ├── glibc-bin-2.23-r1.apk │ └── glibc-i18n-2.23-r1.apk ├── src ├── CC.hs ├── CC │ ├── ShellCheck │ │ ├── Analyze.hs │ │ ├── Env.hs │ │ ├── Fingerprint.hs │ │ ├── ShellScript.hs │ │ └── Types.hs │ └── Types.hs └── Data │ └── Shebang.hs ├── stack.yaml ├── stack.yaml.lock └── test ├── CC └── ShellCheck │ └── FingerprintSpec.hs ├── Spec.hs └── fixtures ├── example ├── example.rb └── example.sh /.codeclimate.yml: -------------------------------------------------------------------------------- 1 | engines: 2 | hlint: 3 | enabled: true 4 | rubocop: 5 | enabled: true 6 | shellcheck: 7 | enabled: true 8 | ratings: 9 | paths: 10 | - "**.hs" 11 | -------------------------------------------------------------------------------- /.dockerignore: -------------------------------------------------------------------------------- 1 | .git 2 | .local/.stack 3 | .local/.stack-work 4 | .stack-work 5 | tags 6 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # haskell 2 | dist 3 | cabal-dev 4 | *.o 5 | *.hi 6 | *.chi 7 | *.chs.h 8 | *.dyn_o 9 | *.dyn_hi 10 | .hpc 11 | .hsenv 12 | .cabal-sandbox/ 13 | cabal.sandbox.config 14 | *.prof 15 | *.aux 16 | *.hp 17 | .stack-work/ 18 | .local/ 19 | TAGS 20 | 21 | # ruby 22 | .ruby-version 23 | 24 | # engine 25 | config.json 26 | -------------------------------------------------------------------------------- /.gitmodules: -------------------------------------------------------------------------------- 1 | [submodule "data/wiki"] 2 | path = data/wiki 3 | url = https://github.com/koalaman/shellcheck.wiki.git 4 | -------------------------------------------------------------------------------- /.local/.gitkeep: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wfleming/codeclimate-shellcheck/99266bd6863824bbd3b4d793e34cea0a6659df13/.local/.gitkeep -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | sudo: false 2 | 3 | # Caching so the next build will be fast too. 4 | cache: 5 | directories: 6 | - $HOME/.stack 7 | 8 | # Download and unpack the stack executable 9 | before_install: 10 | - mkdir -p ~/.local/bin 11 | - export PATH=$HOME/.local/bin:$PATH 12 | - travis_retry curl -L https://www.stackage.org/stack/linux-x86_64 | tar xz --wildcards --strip-components=1 -C ~/.local/bin '*/stack' 13 | - stack config set system-ghc --global true 14 | - export PATH=/opt/ghc/7.10.2/bin:$PATH 15 | 16 | # Install GHC 17 | addons: 18 | apt: 19 | sources: 20 | - hvr-ghc 21 | packages: 22 | - ghc-7.10.2 23 | 24 | # Avoid timeouts 25 | install: 26 | - travis_wait stack --no-terminal --skip-ghc-check setup 27 | - travis_wait stack --no-terminal --skip-ghc-check test --only-snapshot 28 | 29 | # Run the tests 30 | script: 31 | - stack --no-terminal --skip-ghc-check test --fast 32 | -------------------------------------------------------------------------------- /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 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | .PHONY: build 2 | 3 | IMAGE_NAME ?= codeclimate/codeclimate-shellcheck 4 | 5 | data/env.yml: 6 | git submodule init 7 | git submodule update 8 | ./data/prepare.rb 9 | 10 | build: 11 | docker build \ 12 | --tag $(IMAGE_NAME)-build \ 13 | --file $(PWD)/docker/Build.plan . 14 | 15 | .local/bin/codeclimate-shellcheck: build 16 | docker run --rm \ 17 | --volume $(PWD)/.local/bin:/root/.local/bin \ 18 | --volume $(PWD)/.local/.stack:/root/.stack \ 19 | --volume $(PWD)/.local/.stack-work:/home/app/.stack-work \ 20 | $(IMAGE_NAME)-build stack install 21 | 22 | compress: .local/bin/codeclimate-shellcheck 23 | docker run \ 24 | --volume $(PWD)/.local/bin:/data \ 25 | lalyos/upx codeclimate-shellcheck 26 | 27 | image: .local/bin/codeclimate-shellcheck data/env.yml 28 | docker build \ 29 | --tag $(IMAGE_NAME) \ 30 | --file $(PWD)/docker/Release.plan . 31 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # New Maintainer Needed 2 | 3 | Please see https://github.com/mcfilib/codeclimate-shellcheck/issues/66 for more information. 4 | 5 |
6 | 7 | # Code Climate ShellCheck Engine 8 | 9 | [![Code Climate](https://codeclimate.com/github/filib/codeclimate-shellcheck/badges/gpa.svg)](https://codeclimate.com/github/filib/codeclimate-shellcheck) 10 | [![Build Status](https://travis-ci.org/mcfilib/codeclimate-shellcheck.svg?branch=master)](https://travis-ci.org/mcfilib/codeclimate-shellcheck) 11 | 12 | `codeclimate-shellcheck` is a Code Climate engine that wraps 13 | [ShellCheck](http://www.shellcheck.net/). You can run it on your 14 | command line using the Code Climate CLI, or on our hosted analysis 15 | platform. 16 | 17 | `ShellCheck` is a static analysis tool for shell scripts. 18 | 19 | ### Installation 20 | 21 | 1. If you haven't already, [install the Code Climate CLI](https://github.com/codeclimate/codeclimate). 22 | 2. Run `codeclimate engines:enable shellcheck`. This command both installs the engine and enables it in your `.codeclimate.yml` file. 23 | 3. You're ready to analyze! Browse into your project's folder and run `codeclimate analyze`. 24 | 25 | ### Need help? 26 | 27 | For help with `ShellCheck`, 28 | [check out their documentation](http://www.shellcheck.net/). 29 | 30 | If you're running into a Code Climate issue, first look over this 31 | project's 32 | [GitHub Issues](https://github.com/filib/codeclimate-shellcheck), 33 | as your question may have already been covered. If not, 34 | [go ahead and open a support ticket with us](https://codeclimate.com/help). 35 | -------------------------------------------------------------------------------- /Setup.hs: -------------------------------------------------------------------------------- 1 | import Distribution.Simple 2 | main = defaultMain 3 | -------------------------------------------------------------------------------- /app/CLI.hs: -------------------------------------------------------------------------------- 1 | module CLI where 2 | 3 | import Options.Applicative 4 | 5 | -------------------------------------------------------------------------------- 6 | 7 | -- | Represents arguments that can be passed to the CLI. 8 | data CLIOpts = CLIOpts { configPath :: Maybe FilePath 9 | , envPath :: Maybe FilePath 10 | } 11 | 12 | -------------------------------------------------------------------------------- 13 | 14 | -- | Parses CLIOpts and adds description when generating help text. 15 | cliOpts :: ParserInfo CLIOpts 16 | cliOpts = 17 | info (helper <*> cliOptsParser) 18 | (fullDesc 19 | <> progDesc "Print ShellCheck results as CodeClimate engine JSON" 20 | <> header "codeclimate-shellcheck - codeclimate shellcheck engine") 21 | 22 | -------------------------------------------------------------------------------- 23 | 24 | -- | Parses CLIOpts. 25 | cliOptsParser :: Parser CLIOpts 26 | cliOptsParser = 27 | CLIOpts <$> optional (strOption (long "config" 28 | <> help "Location of engine config")) 29 | <*> optional (strOption (long "env" 30 | <> help "Location of engine data mapping")) 31 | -------------------------------------------------------------------------------- /app/Main.hs: -------------------------------------------------------------------------------- 1 | {-# LANGUAGE RecordWildCards #-} 2 | 3 | module Main where 4 | 5 | import CC 6 | import CC.ShellCheck.Analyze 7 | import CC.ShellCheck.Env 8 | import CC.ShellCheck.ShellScript 9 | import CC.ShellCheck.Types 10 | import CLI 11 | import Control.Concurrent 12 | import Control.Monad 13 | import Data.Maybe 14 | import Options.Applicative 15 | 16 | -------------------------------------------------------------------------------- 17 | 18 | main :: IO () 19 | main = execParser cliOpts >>= runCli 20 | 21 | -------------------------------------------------------------------------------- 22 | 23 | -- | Takes CLIOpts options and runs the main program. 24 | runCli :: CLIOpts -> IO () 25 | runCli CLIOpts{..} = do 26 | config <- loadConfig (fromMaybe "./config.json" configPath) 27 | env <- loadEnv (fromMaybe "./data/env.yml" envPath) 28 | scripts <- findShellScripts $! _include_paths config 29 | chan0 <- newChan 30 | chan1 <- dupChan chan0 31 | chan2 <- dupChan chan0 32 | _ <- forkIO (reporter chan1) 33 | _ <- forkIO (analyzer env scripts chan0) 34 | waitUntilReported chan2 35 | where 36 | waitUntilReported :: Chan Analysis -> IO () 37 | waitUntilReported chan = do 38 | analysis <- readChan chan 39 | case analysis of 40 | Reported -> return () 41 | _ -> waitUntilReported chan 42 | 43 | -------------------------------------------------------------------------------- 44 | 45 | -- | Represents three possible states of an analysis chan. 46 | data Analysis = Result !Issue 47 | | Complete 48 | | Reported 49 | deriving Show 50 | 51 | -------------------------------------------------------------------------------- 52 | 53 | -- | Takes a list of scripts, analyzes them and writes the results to a chan. 54 | analyzer :: Env -> [FilePath] -> Chan Analysis -> IO () 55 | analyzer env paths chan = do 56 | forM_ paths $ \path -> do 57 | issues <- analyze env path 58 | mapM_ writeChanAndForce issues 59 | writeChan chan Complete 60 | where 61 | -- | To get brief locking and no space leaks, we need to use a trick. 62 | -- Source: Parallel and Concurrent Programming in Haskell 63 | -- MVar as a Building Block: Unbounded Channels, p135 64 | writeChanAndForce :: Issue -> IO () 65 | writeChanAndForce issue = do 66 | let result = Result issue 67 | writeChan chan result 68 | seq result (return ()) 69 | 70 | -------------------------------------------------------------------------------- 71 | 72 | -- | Continually tries to report issue written to a chan. 73 | reporter :: Chan Analysis -> IO () 74 | reporter chan = doUntilComplete 75 | where 76 | doUntilComplete :: IO () 77 | doUntilComplete = do 78 | analysis <- readChan chan 79 | case analysis of 80 | Result issue -> printIssue issue >> doUntilComplete 81 | Complete -> writeChan chan Reported 82 | Reported -> return () 83 | -------------------------------------------------------------------------------- /codeclimate-shellcheck.cabal: -------------------------------------------------------------------------------- 1 | name: codeclimate-shellcheck 2 | version: 0.1.0.0 3 | synopsis: Code Climate engine that wraps ShellCheck 4 | homepage: https://github.com/filib/codeclimate-shellcheck 5 | license: GPL-3 6 | license-file: LICENSE 7 | author: Philip Cunningham 8 | maintainer: hello@filib.io 9 | category: Static Analysis 10 | build-type: Simple 11 | cabal-version: >=1.10 12 | description: 13 | codeclimate-shellcheck is a Code Climate engine that wraps ShellCheck. 14 | You can run it on your command line using the Code Climate CLI, or on our 15 | hosted analysis platform. 16 | 17 | Source-repository head 18 | type: git 19 | location: https://github.com/filib/codeclimate-shellcheck 20 | 21 | library 22 | exposed-modules: 23 | CC 24 | CC.ShellCheck.Analyze 25 | CC.ShellCheck.Env 26 | CC.ShellCheck.Fingerprint 27 | CC.ShellCheck.ShellScript 28 | CC.ShellCheck.Types 29 | CC.Types 30 | Data.Shebang 31 | build-depends: 32 | base >= 4.7 && <= 5 33 | , aeson 34 | , attoparsec 35 | , bytestring 36 | , containers 37 | , directory 38 | , extra 39 | , filepath 40 | , Glob 41 | , pureMD5 42 | , ShellCheck == 0.7.0 43 | , text 44 | , yaml 45 | hs-source-dirs: src 46 | ghc-options: -Wall 47 | default-language: Haskell2010 48 | 49 | executable codeclimate-shellcheck 50 | main-is: 51 | Main.hs 52 | other-modules: 53 | CLI 54 | build-depends: 55 | base >= 4.7 && <= 5 56 | , codeclimate-shellcheck 57 | , optparse-applicative 58 | hs-source-dirs: app 59 | ghc-options: -Wall -threaded -rtsopts -with-rtsopts=-N 60 | default-language: Haskell2010 61 | 62 | test-suite codeclimate-shellcheck-test 63 | main-is: 64 | Spec.hs 65 | other-modules: 66 | CC.ShellCheck.FingerprintSpec 67 | type: exitcode-stdio-1.0 68 | 69 | build-depends: 70 | base >= 4.7 && <= 5 71 | , codeclimate-shellcheck 72 | , aeson 73 | , aeson-qq 74 | , bytestring 75 | , directory 76 | , filepath 77 | , ShellCheck 78 | , string-qq 79 | , tasty 80 | , tasty-hspec 81 | , tasty-hunit 82 | , text 83 | , temporary 84 | , hspec 85 | hs-source-dirs: test 86 | ghc-options: -Wall 87 | default-language: Haskell2010 88 | -------------------------------------------------------------------------------- /data/prepare.rb: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env ruby 2 | 3 | require 'yaml' 4 | 5 | # String 6 | notice = %( 7 | 8 | ### Notice 9 | 10 | Original content from the ShellCheck https://github.com/koalaman/shellcheck/wiki. 11 | ) 12 | 13 | # IO () 14 | Dir.chdir('data/wiki') 15 | 16 | # [String] 17 | paths = Dir.glob('*.md').select { |path| path =~ /SC\d{3,}.md/ } 18 | 19 | # { String => { String => Integer, String => { String => String } } } 20 | new_env = {} 21 | 22 | # IO () 23 | paths.each do |path| 24 | id = path.scan(/SC\d{3,}/).join 25 | body = File.read(path) + notice 26 | new_env[id] = { 27 | 'remediation_points' => 50_000, 28 | 'content' => { 29 | 'body' => body 30 | } 31 | } 32 | end 33 | 34 | # IO () 35 | Dir.chdir('..') 36 | 37 | # IO String 38 | old_env = YAML.load(File.read('env.yml')) 39 | 40 | # IO () 41 | old_env.each do |key, val| 42 | if (new_val = new_env[key]) 43 | new_val['remediation_points'] = val['remediation_points'] 44 | end 45 | end 46 | 47 | # String 48 | yaml = new_env.to_yaml 49 | 50 | # IO () 51 | File.open('env.yml', 'w') do |file| 52 | file.write(yaml) 53 | end 54 | -------------------------------------------------------------------------------- /docker/Build.plan: -------------------------------------------------------------------------------- 1 | FROM fpco/stack-build:lts-14.1 2 | MAINTAINER Philip Cunningham 3 | 4 | ADD . /home/app 5 | WORKDIR /home/app 6 | CMD ["stack"] 7 | -------------------------------------------------------------------------------- /docker/Release.plan: -------------------------------------------------------------------------------- 1 | FROM alpine:3.3 2 | MAINTAINER Philip Cunningham 3 | 4 | ADD docker/files/ . 5 | RUN apk --allow-untrusted --update add \ 6 | glibc-2.23-r1.apk \ 7 | glibc-bin-2.23-r1.apk \ 8 | glibc-i18n-2.23-r1.apk \ 9 | gmp && \ 10 | /usr/glibc-compat/bin/localedef -i en_US -f UTF-8 en_US.UTF-8 11 | 12 | ENV LANG en_US.UTF-8 13 | 14 | RUN adduser -u 9000 -h /home/app -D app 15 | USER app 16 | WORKDIR /home/app 17 | 18 | COPY src /home/app/src 19 | COPY LICENSE /home/app/LICENSE 20 | ADD .local/bin/codeclimate-shellcheck /home/app/bin/engine 21 | ADD data/env.yml /home/app/env.yml 22 | 23 | VOLUME /code 24 | WORKDIR /code 25 | ENTRYPOINT ["/home/app/bin/engine", "--config", "/config.json", "--env", "/home/app/env.yml"] 26 | -------------------------------------------------------------------------------- /docker/files/glibc-2.23-r1.apk: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wfleming/codeclimate-shellcheck/99266bd6863824bbd3b4d793e34cea0a6659df13/docker/files/glibc-2.23-r1.apk -------------------------------------------------------------------------------- /docker/files/glibc-bin-2.23-r1.apk: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wfleming/codeclimate-shellcheck/99266bd6863824bbd3b4d793e34cea0a6659df13/docker/files/glibc-bin-2.23-r1.apk -------------------------------------------------------------------------------- /docker/files/glibc-i18n-2.23-r1.apk: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wfleming/codeclimate-shellcheck/99266bd6863824bbd3b4d793e34cea0a6659df13/docker/files/glibc-i18n-2.23-r1.apk -------------------------------------------------------------------------------- /src/CC.hs: -------------------------------------------------------------------------------- 1 | {-# LANGUAGE OverloadedStrings #-} 2 | 3 | module CC ( 4 | -- * Handle engine configuration 5 | loadConfig 6 | -- * Handle engine results 7 | , printIssue 8 | -- * Re-export common types 9 | , module CC.Types 10 | ) where 11 | 12 | import CC.Types 13 | import Data.Aeson 14 | import qualified Data.ByteString.Lazy as BSL 15 | import Data.Maybe 16 | import System.Directory 17 | 18 | -------------------------------------------------------------------------------- 19 | 20 | -- | Load config from CodeClimate engine path or use a default. 21 | loadConfig :: FilePath -> IO Config 22 | loadConfig path = do 23 | fileExists <- doesFileExist path 24 | config <- if fileExists 25 | then decode <$> BSL.readFile path 26 | else return Nothing 27 | return $! fromMaybe (Config []) config 28 | 29 | -------------------------------------------------------------------------------- 30 | 31 | -- | Print an issue to the console as per CodeClimate spec. 32 | printIssue :: Issue -> IO () 33 | printIssue = BSL.putStr . (<> "\0") . encode 34 | -------------------------------------------------------------------------------- /src/CC/ShellCheck/Analyze.hs: -------------------------------------------------------------------------------- 1 | {-# LANGUAGE OverloadedStrings #-} 2 | 3 | module CC.ShellCheck.Analyze where 4 | 5 | import CC.ShellCheck.Fingerprint 6 | import CC.ShellCheck.Types as CC 7 | import CC.Types as CC 8 | import Control.Exception.Base 9 | import qualified Data.Map.Strict as DM 10 | import qualified Data.Text as T 11 | import ShellCheck.Checker 12 | import ShellCheck.Interface 13 | 14 | -------------------------------------------------------------------------------- 15 | 16 | -- | Main function for analyzing a shell script. 17 | analyze :: Env -> FilePath -> IO [Issue] 18 | analyze env path = do 19 | shellScript <- readFile path 20 | result <- checkScript interface $! checkSpec shellScript 21 | return $! fromCheckResult env result shellScript 22 | where 23 | checkSpec :: String -> CheckSpec 24 | checkSpec x = emptyCheckSpec { csFilename = path, csScript = x } 25 | 26 | interface :: SystemInterface IO 27 | interface = SystemInterface 28 | { siReadFile = defaultInterface 29 | , siFindSource = error "TODO" 30 | , siGetConfig = error "TODO" 31 | } 32 | 33 | -------------------------------------------------------------------------------- 34 | 35 | -- | Builds default IO interface with error handling. 36 | defaultInterface :: FilePath -> IO (Either ErrorMessage String) 37 | defaultInterface path = catch (Right <$> readFile path) handler 38 | where 39 | handler :: IOException -> IO (Either ErrorMessage String) 40 | handler ex = return . Left $! show ex 41 | 42 | -------------------------------------------------------------------------------- 43 | 44 | -- | The baseline remediation points value is 50,000, which is the time it takes 45 | -- to fix a trivial code style issue like a missing semicolon on a single line, 46 | -- including the time for the developer to open the code, make the change, and 47 | -- confidently commit the fix. All other remediation points values are expressed 48 | -- in multiples of that Basic Remediation Point Value. 49 | defaultRemediationPoints :: Int 50 | defaultRemediationPoints = 50000 51 | 52 | -------------------------------------------------------------------------------- 53 | 54 | -- | Maps Severity to Category. 55 | fromSeverity :: Severity -> Category 56 | fromSeverity ErrorC = BugRisk 57 | fromSeverity InfoC = BugRisk 58 | fromSeverity StyleC = Style 59 | fromSeverity WarningC = BugRisk 60 | 61 | -------------------------------------------------------------------------------- 62 | 63 | -- | Maps CheckResult into issues. 64 | fromCheckResult :: Env -> CheckResult -> String -> [Issue] 65 | fromCheckResult env cr shellScript = fromPositionedComment env shellScript <$> crComments cr 66 | 67 | -------------------------------------------------------------------------------- 68 | 69 | -- | Maps from a PositionedComment to an Issue. 70 | fromPositionedComment :: Env -> String -> PositionedComment -> Issue 71 | fromPositionedComment env shellScript p = 72 | Issue { _check_name = checkName 73 | , _description = description 74 | , _categories = categories 75 | , _location = location 76 | , _remediation_points = remediationPoints 77 | , _content = content 78 | , _other_locations = Nothing 79 | , _fingerprint = issueFingerprint p $ T.pack shellScript 80 | } 81 | where 82 | checkName :: T.Text 83 | checkName = "SC" <> T.pack (show code) 84 | 85 | description :: T.Text 86 | description = T.pack desc 87 | 88 | categories :: [Category] 89 | categories = [fromSeverity severity] 90 | 91 | coords :: CC.Position 92 | coords = Coords (LineColumn (fromIntegral $ posLine pos) (fromIntegral $ posColumn pos)) 93 | 94 | location :: Location 95 | location = Location (posFile pos) $! PositionBased coords coords 96 | 97 | mapping :: Maybe Mapping 98 | mapping = DM.lookup checkName env 99 | 100 | remediationPoints :: Maybe Int 101 | remediationPoints = case mapping of 102 | Just (Mapping x _) -> Just x 103 | Nothing -> Just $! case severity of 104 | ErrorC -> 4 * defaultRemediationPoints 105 | WarningC -> 3 * defaultRemediationPoints 106 | InfoC -> 2 * defaultRemediationPoints 107 | StyleC -> 1 * defaultRemediationPoints 108 | 109 | content :: Maybe Content 110 | content = fmap (\(Mapping _ x) -> x) mapping 111 | 112 | pos = pcStartPos p 113 | comment = pcComment p 114 | code = cCode comment 115 | severity = cSeverity comment 116 | desc = cMessage comment 117 | -------------------------------------------------------------------------------- /src/CC/ShellCheck/Env.hs: -------------------------------------------------------------------------------- 1 | module CC.ShellCheck.Env where 2 | 3 | import CC.ShellCheck.Types 4 | import qualified Data.Map.Strict as DM 5 | import Data.Maybe 6 | import qualified Data.Yaml as YML 7 | import System.Directory 8 | 9 | -------------------------------------------------------------------------------- 10 | 11 | -- | Load environment that maps remediation points to textual content. 12 | loadEnv :: FilePath -> IO Env 13 | loadEnv path = do 14 | fileExists <- doesFileExist path 15 | config <- if fileExists 16 | then either (const Nothing) Just <$> YML.decodeFileEither path 17 | else return Nothing 18 | return $! fromMaybe DM.empty config 19 | -------------------------------------------------------------------------------- /src/CC/ShellCheck/Fingerprint.hs: -------------------------------------------------------------------------------- 1 | {-# LANGUAGE OverloadedStrings #-} 2 | 3 | module CC.ShellCheck.Fingerprint 4 | ( issueFingerprint 5 | ) where 6 | 7 | import Data.Char (isSpace) 8 | import Data.Maybe (fromMaybe) 9 | import Data.Text (Text) 10 | import Data.Text.Lazy (fromStrict) 11 | import Data.Text.Lazy.Encoding (encodeUtf8) 12 | import ShellCheck.Interface 13 | ( Comment(..) 14 | , Position(..) 15 | , PositionedComment(..) 16 | ) 17 | 18 | import qualified Data.Digest.Pure.MD5 as MD5 19 | import qualified Data.Text as T 20 | 21 | -- | Given a positioned comment and the file's contents, generate a fingerprint 22 | -- unique to that issue 23 | issueFingerprint :: PositionedComment -> Text -> Text 24 | issueFingerprint pc script = 25 | md5 $ T.intercalate "|" 26 | [ T.pack $ posFile pos 27 | , T.pack $ show code 28 | , T.filter (not . isSpace) $ fetchLine (fromIntegral $ posLine pos) script 29 | ] 30 | where 31 | pos = pcStartPos pc 32 | comment = pcComment pc 33 | code = cCode comment 34 | 35 | md5 :: Text -> Text 36 | md5 = T.pack . show . MD5.md5 . encodeUtf8 . fromStrict 37 | 38 | fetchLine :: Int -> Text -> Text 39 | fetchLine idx = fromMaybe "" . safeIndex (idx - 1) . T.lines 40 | 41 | safeIndex :: Int -> [a] -> Maybe a 42 | safeIndex idx xs 43 | | idx >= 0 && idx < length xs = Just $ xs !! idx 44 | | otherwise = Nothing 45 | -------------------------------------------------------------------------------- /src/CC/ShellCheck/ShellScript.hs: -------------------------------------------------------------------------------- 1 | {-# LANGUAGE OverloadedStrings #-} 2 | 3 | module CC.ShellCheck.ShellScript ( 4 | -- * Validation 5 | isShellScript 6 | , hasShellExtension 7 | , hasValidInterpretter 8 | -- * Retrieval 9 | , findShellScripts 10 | ) where 11 | 12 | import Control.Monad.Extra 13 | import qualified Data.ByteString as BS 14 | import qualified Data.ByteString.Char8 as Char8 15 | import Data.List 16 | import Data.Shebang (Shebang(..), Interpretter(..), Argument(..)) 17 | import qualified Data.Shebang as Shebang 18 | import System.Directory 19 | import System.FilePath.Glob 20 | import System.FilePath.Posix 21 | 22 | -------------------------------------------------------------------------------- 23 | 24 | -- | List of shells the engine should be able to handle. 25 | validShells :: [BS.ByteString] 26 | validShells = ["sh", "ash", "dash", "bash", "ksh"] 27 | 28 | -------------------------------------------------------------------------------- 29 | 30 | -- | List of valid shell file extensions. 31 | validShellExtensions :: [BS.ByteString] 32 | validShellExtensions = ("." <>) <$> validShells 33 | 34 | -------------------------------------------------------------------------------- 35 | 36 | -- | Checks to see if file has correct extension. 37 | hasShellExtension :: FilePath -> Bool 38 | hasShellExtension path = extension `elem` validShellExtensions 39 | where 40 | extension :: BS.ByteString 41 | extension = Char8.pack $ takeExtension path 42 | 43 | -------------------------------------------------------------------------------- 44 | 45 | -- | Checks to see if script has a valid interpretter. 46 | hasValidInterpretter :: Shebang -> Bool 47 | hasValidInterpretter (Shebang (Interpretter int) maybeArgument) = 48 | if BS.isSuffixOf "env" int 49 | then case maybeArgument of 50 | Nothing -> False 51 | Just (Argument arg) -> any (`BS.isPrefixOf` arg) validShells 52 | else any (`BS.isSuffixOf` int) validShells 53 | 54 | -------------------------------------------------------------------------------- 55 | 56 | -- | Determines whether a file is a valid shell script. 57 | isShellScript :: FilePath -> IO Bool 58 | isShellScript path = 59 | if hasExtension path 60 | then return $! hasShellExtension path 61 | else do 62 | header <- Shebang.readFirstLine path 63 | case Shebang.decode header of 64 | Just shebang -> return $! hasValidInterpretter shebang 65 | Nothing -> return False 66 | 67 | -------------------------------------------------------------------------------- 68 | 69 | -- | Retrieve shell scripts for a list of paths. 70 | findShellScripts :: [FilePath] -> IO [FilePath] 71 | findShellScripts paths = do 72 | dotShFiles <- concat <$> globDir patterns "." 73 | allScripts <- filterM validateScript $! dotShFiles ++ otherFiles 74 | return $ fmap clean allScripts 75 | where 76 | dirs :: [FilePath]; otherFiles :: [FilePath] 77 | (dirs, otherFiles) = partition hasTrailingPathSeparator paths 78 | 79 | clean :: String -> String 80 | clean ('.':'/':x) = x 81 | clean x = x 82 | 83 | patterns :: [Pattern] 84 | patterns = fmap (compile . (++ "**/*")) dirs 85 | 86 | validateScript :: FilePath -> IO Bool 87 | validateScript x = doesFileExist x &&^ isShellScript x 88 | -------------------------------------------------------------------------------- /src/CC/ShellCheck/Types.hs: -------------------------------------------------------------------------------- 1 | {-# LANGUAGE OverloadedStrings #-} 2 | 3 | module CC.ShellCheck.Types where 4 | 5 | import CC.Types 6 | import Control.Applicative 7 | import Data.Aeson 8 | import qualified Data.Map.Strict as DM 9 | import qualified Data.Text as T 10 | 11 | -------------------------------------------------------------------------------- 12 | 13 | -- | Remediation points and associated textual content. 14 | data Mapping = Mapping Int Content deriving Show 15 | 16 | instance FromJSON Mapping where 17 | parseJSON (Object x) = do 18 | points <- x .: "remediation_points" 19 | content <- x .: "content" 20 | return $! Mapping points content 21 | parseJSON _ = empty 22 | 23 | -------------------------------------------------------------------------------- 24 | 25 | -- | Represents mappings between check names, content and remediation points. 26 | type Env = DM.Map T.Text Mapping 27 | -------------------------------------------------------------------------------- /src/CC/Types.hs: -------------------------------------------------------------------------------- 1 | {-# LANGUAGE DeriveGeneric #-} 2 | {-# LANGUAGE OverloadedStrings #-} 3 | {-# LANGUAGE RecordWildCards #-} 4 | 5 | module CC.Types where 6 | 7 | import Control.Applicative 8 | import Data.Aeson 9 | import Data.Aeson.Types 10 | import Data.Maybe (fromMaybe) 11 | import Data.Text (Text) 12 | import qualified Data.Text as T 13 | import GHC.Generics 14 | 15 | -------------------------------------------------------------------------------- 16 | 17 | -- | Issues must be associated with one or more categories. 18 | data Category = BugRisk 19 | | Clarity 20 | | Compatibility 21 | | Complexity 22 | | Duplication 23 | | Security 24 | | Style 25 | deriving Show 26 | 27 | instance ToJSON Category where 28 | toJSON BugRisk = "Bug Risk" 29 | toJSON x = toJSON $! show x 30 | 31 | -------------------------------------------------------------------------------- 32 | 33 | -- | Line and column numbers are 1-based. 34 | data LineColumn = LineColumn { 35 | _line :: {-# UNPACK #-} !Int 36 | , _column :: {-# UNPACK #-} !Int 37 | } deriving (Generic, Show) 38 | 39 | instance ToJSON LineColumn where 40 | toJSON = genericToJSON defaultOptions { fieldLabelModifier = drop 1 } 41 | 42 | -------------------------------------------------------------------------------- 43 | 44 | -- | Positions refer to specific characters within a source file, and can be 45 | -- expressed in two ways. 46 | data Position = Coords !LineColumn 47 | -- ^ Line and column coordinates. 48 | | Offset {-# UNPACK #-} !Int 49 | -- ^ Absolute character offsets, for the entire source buffer. 50 | deriving Show 51 | 52 | instance ToJSON Position where 53 | toJSON (Coords x) = toJSON x 54 | toJSON (Offset x) = object [ "offset" .= x ] 55 | 56 | -------------------------------------------------------------------------------- 57 | 58 | -- | Line-based locations emit a beginning and end line number for the issue, 59 | -- whereas position-based locations allow more precision. 60 | data BeginEnd = PositionBased Position Position 61 | | LineBased {-# UNPACK #-} !Int {-# UNPACK #-} !Int 62 | deriving Show 63 | 64 | instance ToJSON BeginEnd where 65 | toJSON z = object $! case z of 66 | PositionBased x y -> f x y 67 | LineBased x y -> f x y 68 | where 69 | f :: (ToJSON a) => a -> a -> [Pair] 70 | f x y = [ "begin" .= x, "end" .= y ] 71 | 72 | -------------------------------------------------------------------------------- 73 | 74 | -- | Locations refer to ranges of a source code file. 75 | data Location = Location FilePath BeginEnd deriving Show 76 | 77 | instance ToJSON Location where 78 | toJSON (Location x y) = object $! case y of 79 | PositionBased _ _ -> [ f x, "positions" .= y ] 80 | LineBased _ _ -> [ f x, "lines" .= y ] 81 | where 82 | f :: FilePath -> Pair 83 | f p = "path" .= stripPrefix "./" (T.pack p) 84 | 85 | -- A version that doesn't return Maybe but gives back the original value 86 | -- if the prefix wasn't present. 87 | stripPrefix :: Text -> Text -> Text 88 | stripPrefix p fp = fromMaybe fp $ T.stripPrefix p fp 89 | 90 | -------------------------------------------------------------------------------- 91 | 92 | -- | A markdown snippet describing the issue, including deeper explanations and 93 | -- links to other resources. 94 | data Content = Body T.Text deriving Show 95 | 96 | instance ToJSON Content where 97 | toJSON (Body x) = object [ "body" .= x ] 98 | 99 | instance FromJSON Content where 100 | parseJSON (Object x) = Body <$> x .: "body" 101 | parseJSON _ = empty 102 | 103 | -------------------------------------------------------------------------------- 104 | 105 | -- | An issue represents a single instance of a real or potential code problem, 106 | -- detected by a static analysis Engine. 107 | data Issue = Issue { 108 | _check_name :: !T.Text 109 | , _description :: !T.Text 110 | , _categories :: ![Category] 111 | , _location :: !Location 112 | , _remediation_points :: !(Maybe Int) 113 | , _content :: !(Maybe Content) 114 | , _other_locations :: !(Maybe [Location]) 115 | , _fingerprint :: !T.Text 116 | } deriving Show 117 | 118 | instance ToJSON Issue where 119 | toJSON Issue{..} = (object . withoutNulls) [ 120 | "type" .= ("issue" :: T.Text) 121 | , "check_name" .= _check_name 122 | , "description" .= _description 123 | , "categories" .= _categories 124 | , "location" .= _location 125 | , "remediation_points" .= _remediation_points 126 | , "content" .= _content 127 | , "other_locations" .= _other_locations 128 | , "fingerprint" .= _fingerprint 129 | ] 130 | where 131 | withoutNulls :: [(a, Value)] -> [(a, Value)] 132 | withoutNulls = filter (\(_, v) -> v /= Null) 133 | 134 | -------------------------------------------------------------------------------- 135 | 136 | -- | Engine configuration mounted at /config.json. 137 | data Config = Config { _include_paths :: ![FilePath] } deriving (Generic, Show) 138 | 139 | instance FromJSON Config where 140 | parseJSON = genericParseJSON defaultOptions { fieldLabelModifier = drop 1 } 141 | -------------------------------------------------------------------------------- /src/Data/Shebang.hs: -------------------------------------------------------------------------------- 1 | {-# LANGUAGE OverloadedStrings #-} 2 | 3 | module Data.Shebang ( 4 | -- * Decoding 5 | decode 6 | , decodeEither 7 | -- * Smoke tests 8 | , hasShebang 9 | -- * Reading 10 | , readFirstLine 11 | -- * Core types 12 | , Shebang(..) 13 | , Interpretter(..) 14 | , Argument(..) 15 | ) where 16 | 17 | import Data.Attoparsec.ByteString.Lazy 18 | import qualified Data.ByteString as BS 19 | import qualified Data.ByteString.Lazy as BSL 20 | import Data.Word 21 | 22 | -------------------------------------------------------------------------------- 23 | 24 | -- | Newtype wrapper for Interpretter. 25 | newtype Interpretter = Interpretter { _interpretter :: BS.ByteString } 26 | deriving (Eq, Show) 27 | 28 | -- | Newtype wrapper for argument. 29 | newtype Argument = Argument { _argument :: BS.ByteString } 30 | deriving (Eq, Show) 31 | 32 | -- | Value representing a Shebang of the form #!interpreter [optional-arg]. 33 | data Shebang = Shebang Interpretter (Maybe Argument) 34 | deriving (Eq, Show) 35 | 36 | -------------------------------------------------------------------------------- 37 | 38 | -- | Checks the magic characters of a ByteString 39 | hasShebang :: BSL.ByteString -> Bool 40 | hasShebang x = BSL.take 2 x == "#!" 41 | 42 | -------------------------------------------------------------------------------- 43 | 44 | -- | Reads first line of a file. 45 | readFirstLine :: FilePath -> IO BSL.ByteString 46 | readFirstLine path = do 47 | contents <- BSL.readFile path 48 | return $ BSL.takeWhile (\x -> not $ x == 10 || x == 13) contents 49 | 50 | -------------------------------------------------------------------------------- 51 | 52 | -- | Takes a ByteString and maybe returns a Shebang. 53 | decode :: BSL.ByteString -> Maybe Shebang 54 | decode = maybeResult . parse shebang 55 | 56 | -------------------------------------------------------------------------------- 57 | 58 | -- | Takes a ByteString and returns a Shebang or an error string. 59 | decodeEither :: BSL.ByteString -> Either String Shebang 60 | decodeEither = eitherResult . parse shebang 61 | 62 | -------------------------------------------------------------------------------- 63 | 64 | -- | Simple Shebang parser. 65 | shebang :: Parser Shebang 66 | shebang = do 67 | _ <- string "#!" 68 | interpretter <- takeTill (\x -> whitespace x || endOfLine x) 69 | argument <- option "" $ do 70 | _ <- string " " 71 | takeTill endOfLine 72 | return $! case argument of 73 | "" -> Shebang (Interpretter interpretter) Nothing 74 | x -> Shebang (Interpretter interpretter) (Just (Argument x)) 75 | 76 | ---------------------------------------------------------------------------- 77 | 78 | -- | Character representing a carriage return. 79 | carriageReturn :: Word8 -> Bool 80 | carriageReturn = (==) 13 81 | 82 | ---------------------------------------------------------------------------- 83 | 84 | -- | Characters representing end of line. 85 | endOfLine :: Word8 -> Bool 86 | endOfLine x = newline x || carriageReturn x 87 | 88 | ---------------------------------------------------------------------------- 89 | 90 | -- | Character representing a new line. 91 | newline :: Word8 -> Bool 92 | newline = (==) 10 93 | 94 | ---------------------------------------------------------------------------- 95 | 96 | -- | Character representing spaces. 97 | whitespace :: Word8 -> Bool 98 | whitespace = (==) 32 99 | -------------------------------------------------------------------------------- /stack.yaml: -------------------------------------------------------------------------------- 1 | resolver: lts-14.1 2 | system-ghc: false 3 | install-ghc: true 4 | -------------------------------------------------------------------------------- /stack.yaml.lock: -------------------------------------------------------------------------------- 1 | # This file was autogenerated by Stack. 2 | # You should not edit this file by hand. 3 | # For more information, please see the documentation at: 4 | # https://docs.haskellstack.org/en/stable/lock_files 5 | 6 | packages: [] 7 | snapshots: 8 | - completed: 9 | size: 523448 10 | url: https://raw.githubusercontent.com/commercialhaskell/stackage-snapshots/master/lts/14/1.yaml 11 | sha256: 0045b9bae36c3bb2dd374c29b586389845af1557eea0423958d152fc500d4fbf 12 | original: lts-14.1 13 | -------------------------------------------------------------------------------- /test/CC/ShellCheck/FingerprintSpec.hs: -------------------------------------------------------------------------------- 1 | {-# LANGUAGE OverloadedStrings #-} 2 | 3 | module CC.ShellCheck.FingerprintSpec 4 | ( main 5 | , fingerprintSpecs 6 | ) where 7 | 8 | import CC.ShellCheck.Fingerprint 9 | 10 | import Data.Text (Text) 11 | import ShellCheck.Interface 12 | ( Code 13 | , Comment(..) 14 | , newComment 15 | , Position(..) 16 | , newPosition 17 | , PositionedComment(..) 18 | , newPositionedComment 19 | , Severity(..) 20 | ) 21 | import Test.Hspec 22 | 23 | import qualified Data.Text as T 24 | 25 | main :: IO () 26 | main = hspec fingerprintSpecs 27 | 28 | fingerprintSpecs :: Spec 29 | fingerprintSpecs = describe "issueFingerprint" $ do 30 | it "uniquely identifies an issue" $ do 31 | let content = T.unlines 32 | [ "#!/bin/sh" 33 | , "" 34 | , "foo = $*" 35 | , "" 36 | , "bar = $*" 37 | , "" 38 | ] 39 | fp1 = fingerprint 3 123 content 40 | fp2 = fingerprint 5 123 content 41 | fp3 = fingerprint 5 456 content 42 | 43 | fp1 `shouldNotBe` fp2 44 | fp2 `shouldNotBe` fp3 45 | 46 | it "is robust against the issue moving" $ do 47 | let fp1 = fingerprint 3 123 $ T.unlines 48 | [ "#!/bin/sh" 49 | , "" 50 | , "foo = $*" 51 | ] 52 | fp2 = fingerprint 5 123 $ T.unlines 53 | [ "#!/bin/sh" 54 | , "" 55 | , "" 56 | , "" 57 | , "foo = $*" 58 | ] 59 | 60 | fp1 `shouldBe` fp2 61 | 62 | it "is robust against whitespace" $ do 63 | let fp1 = fingerprint 3 123 $ T.unlines 64 | [ "#!/bin/sh" 65 | , "" 66 | , "foo = $*" 67 | ] 68 | fp2 = fingerprint 3 123 $ T.unlines 69 | [ "#!/bin/sh" 70 | , "" 71 | , "foo = $*" 72 | ] 73 | 74 | fp1 `shouldBe` fp2 75 | 76 | fingerprint :: Integer -> Code -> Text -> Text 77 | fingerprint ln code = 78 | issueFingerprint $ newPositionedComment 79 | { pcStartPos = position ln 80 | , pcEndPos = unused 81 | , pcComment = comment code 82 | } 83 | where 84 | unused :: a 85 | unused = error "end position comment not implemented" 86 | 87 | position :: Integer -> Position 88 | position ln = newPosition 89 | { posFile = "foo.sh" 90 | , posLine = ln 91 | , posColumn = 0 92 | } 93 | 94 | comment :: Code -> Comment 95 | comment code = newComment 96 | { cSeverity = ErrorC 97 | , cCode = code 98 | , cMessage = "" 99 | } 100 | -------------------------------------------------------------------------------- /test/Spec.hs: -------------------------------------------------------------------------------- 1 | {-# LANGUAGE OverloadedStrings #-} 2 | {-# LANGUAGE QuasiQuotes #-} 3 | 4 | import qualified Control.Exception as E 5 | import qualified Data.ByteString.Lazy as BSL 6 | import Data.String.QQ 7 | import System.Directory 8 | import System.FilePath 9 | import System.IO.Temp 10 | import Test.Tasty 11 | import Test.Tasty.Hspec 12 | 13 | import CC.ShellCheck.ShellScript 14 | import Data.Shebang 15 | 16 | import CC.ShellCheck.FingerprintSpec (fingerprintSpecs) 17 | 18 | -------------------------------------------------------------------------------- 19 | 20 | main :: IO () 21 | main = do 22 | sbSpecs <- testSpec "Shebang Specs" shebangSpecs 23 | ssSpecs <- testSpec "ShellScript Specs" shellscriptSpecs 24 | fpSpecs <- testSpec "Fingerprint Specs" fingerprintSpecs 25 | defaultMain (tests $ testGroup "All specs" [ sbSpecs, ssSpecs, fpSpecs ]) 26 | 27 | tests :: TestTree -> TestTree 28 | tests specs = testGroup "Engine Tests" [ specs ] 29 | 30 | -------------------------------------------------------------------------------- 31 | 32 | shebang :: BSL.ByteString 33 | shebang = "#!/bin/sh" 34 | 35 | shScript :: BSL.ByteString 36 | shScript = [s|#!/bin/sh 37 | echo "hello world"|] 38 | 39 | rbScript :: BSL.ByteString 40 | rbScript = [s|#!/bin/env ruby 41 | puts "hello world"|] 42 | 43 | -------------------------------------------------------------------------------- 44 | 45 | shebangSpecs :: Spec 46 | shebangSpecs = describe "Shebang parsing" $ do 47 | describe "decode" $ do 48 | it "should parse a valid shebang without optional args" $ do 49 | let subject = shScript 50 | let result = decode subject 51 | result `shouldBe` Just (Shebang (Interpretter "/bin/sh") Nothing) 52 | 53 | it "should parse a valid shebang with optional args" $ do 54 | let subject = rbScript 55 | let result = decode subject 56 | result `shouldBe` Just (Shebang (Interpretter "/bin/env") (Just (Argument "ruby"))) 57 | 58 | describe "decodeEither" $ do 59 | it "should parse a valid shebang without optional args" $ do 60 | let subject = shScript 61 | let result = decodeEither subject 62 | result `shouldBe` Right (Shebang (Interpretter "/bin/sh") Nothing) 63 | 64 | describe "hasShebang" $ do 65 | it "should be able to detect a valid shebang" $ do 66 | let subject = shebang 67 | let result = hasShebang subject 68 | result `shouldBe` True 69 | 70 | it "should be able to detect when shebang is missing" $ do 71 | let subject = BSL.empty 72 | let result = hasShebang subject 73 | result `shouldBe` False 74 | 75 | describe "readFirstLine" $ do 76 | it "should only read the first line" $ do 77 | let contents = shScript 78 | withinTempDir $ do 79 | let subject = "example.sh" 80 | createFile subject contents 81 | result <- readFirstLine subject 82 | result `shouldBe` shebang 83 | 84 | -------------------------------------------------------------------------------- 85 | 86 | shellscriptSpecs :: Spec 87 | shellscriptSpecs = describe "Shellscript validation and retrieval" $ do 88 | describe "isShellScript" $ do 89 | it "should be valid if file has .sh extension" $ do 90 | withinTempDir $ do 91 | let subject = "example.sh" 92 | createFile subject BSL.empty 93 | result <- isShellScript subject 94 | result `shouldBe` True 95 | 96 | it "should be valid if file has no extension but a valid shebang" $ do 97 | withinTempDir $ do 98 | let subject = "example" 99 | createFile subject shScript 100 | result <- isShellScript subject 101 | result `shouldBe` True 102 | 103 | it "should not be valid if file has no extension and an invalid shebang" $ do 104 | withinTempDir $ do 105 | let subject = "example" 106 | createFile subject rbScript 107 | result <- isShellScript subject 108 | result `shouldBe` False 109 | 110 | describe "hasShellExtension" $ do 111 | it "should be valid if file has .sh extension" $ do 112 | let subject = "example.sh" 113 | let result = hasShellExtension subject 114 | result `shouldBe` True 115 | 116 | it "should be valid if file has .ash extension" $ do 117 | let subject = "example.ash" 118 | let result = hasShellExtension subject 119 | result `shouldBe` True 120 | 121 | it "should be valid if file has .dash extension" $ do 122 | let subject = "example.dash" 123 | let result = hasShellExtension subject 124 | result `shouldBe` True 125 | 126 | it "should be valid if file has .bash extension" $ do 127 | let subject = "example.bash" 128 | let result = hasShellExtension subject 129 | result `shouldBe` True 130 | 131 | it "should be valid if file has .ksh extension" $ do 132 | let subject = "example.ksh" 133 | let result = hasShellExtension subject 134 | result `shouldBe` True 135 | 136 | it "should not be valid if file has no extension" $ do 137 | let subject = "example" 138 | let result = hasShellExtension subject 139 | result `shouldBe` False 140 | 141 | describe "hasValidInterpretter" $ do 142 | it "should be valid if sh is interpretter" $ do 143 | let subject = Shebang (Interpretter "/bin/sh") Nothing 144 | let result = hasValidInterpretter subject 145 | result `shouldBe` True 146 | 147 | let subject' = Shebang (Interpretter "/bin/env") (Just (Argument "sh")) 148 | let result' = hasValidInterpretter subject' 149 | result' `shouldBe` True 150 | 151 | it "should be valid if bash is interpretter" $ do 152 | let subject = Shebang (Interpretter "/bin/bash") Nothing 153 | let result = hasValidInterpretter subject 154 | result `shouldBe` True 155 | 156 | let subject' = Shebang (Interpretter "/bin/env") (Just (Argument "bash")) 157 | let result' = hasValidInterpretter subject' 158 | result' `shouldBe` True 159 | 160 | it "should be not be valid if ruby is interpretter" $ do 161 | let subject = Shebang (Interpretter "/bin/ruby") Nothing 162 | let result = hasValidInterpretter subject 163 | result `shouldBe` False 164 | 165 | let subject' = Shebang (Interpretter "/bin/env") (Just (Argument "ruby")) 166 | let result' = hasValidInterpretter subject' 167 | result' `shouldBe` False 168 | 169 | describe "findShellScripts" $ do 170 | describe "when i specify a list of files" $ do 171 | it "should filter out scripts that aren't shell scripts" $ do 172 | let subject = [ "test/fixtures/example" 173 | , "test/fixtures/example.sh" 174 | , "test/fixtures/example.rb" 175 | ] 176 | result <- findShellScripts subject 177 | result `shouldBe` [ "test/fixtures/example", "test/fixtures/example.sh" ] 178 | 179 | describe "when i specify a list of directories" $ do 180 | it "should give me all shell script files, regardless of extension" $ do 181 | let subject = [ "test/fixtures/" ] 182 | result <- findShellScripts subject 183 | result `shouldBe` [ "test/fixtures/example", "test/fixtures/example.sh" ] 184 | 185 | -------------------------------------------------------------------------------- 186 | 187 | withinTempDir :: IO a -> IO a 188 | withinTempDir act = withSystemTempDirectory "cc-hlint" $ \tmp -> do 189 | E.bracket getCurrentDirectory setCurrentDirectory $ \_ -> 190 | setCurrentDirectory tmp >> act 191 | 192 | createFile :: FilePath -> BSL.ByteString -> IO () 193 | createFile path content = do 194 | createDirectoryIfMissing True $ takeDirectory path 195 | BSL.writeFile path content 196 | -------------------------------------------------------------------------------- /test/fixtures/example: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | ## Example of a broken script. Hit the Down Arrow button to ShellCheck it! 3 | for f in $(ls *.m3u) 4 | do 5 | grep -qi hq.*mp3 $f \ 6 | && echo -e 'Playlist $f contains a HQ file in mp3 format' 7 | done 8 | -------------------------------------------------------------------------------- /test/fixtures/example.rb: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env ruby 2 | 3 | puts "hello world" 4 | -------------------------------------------------------------------------------- /test/fixtures/example.sh: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | ## Example of a broken script. Hit the Down Arrow button to ShellCheck it! 3 | for f in $(ls *.m3u) 4 | do 5 | grep -qi hq.*mp3 $f \ 6 | && echo -e 'Playlist $f contains a HQ file in mp3 format' 7 | done 8 | --------------------------------------------------------------------------------