- Puppet 3 Cookbook
- John Arundel
- 493字
- 2021-04-09 23:52:27
Checking your manifests with puppet-lint
The Puppet Labs official style guide outlines a number of style conventions for Puppet code, some of which we've touched on in the preceding section. For example, according to the style guide, manifests:
- Must use two-space soft tabs
- Must not use literal tab characters
- Must not contain trailing white space
- Should not exceed an 80 character line width
- Should align parameter arrows (
=>) within blocks
Following the style guide will make sure that your Puppet code is easy to read and maintain and, if you're planning to release your code to the public, style compliance is essential. The puppet-lint tool will automatically check your code against the style guide. Here's how to use it:
Getting ready
Here's what you need to do to install puppet-lint:
- Run the following command (we'll install
puppet-lintas a gem, because that version is much more up-to-date than the APT package available in the Ubuntu Precise repo):ubuntu@cookbook:~/puppet$ sudo gem install puppet-lint --no-ri --no-rdoc Successfully installed puppet-lint-0.3.2 1 gem installed
How to do it...
Follow these steps to use puppet-lint:
- Choose a Puppet manifest file that you want to check with
puppet-lint, and run the following command:ubuntu@cookbook:~/puppet$ puppet-lint modules/admin/manifests/ntp.pp WARNING: indentation of => is not properly aligned on line 9 ERROR: trailing whitespace found on line 13 WARNING: double quoted string containing no variables on line 3
- As you can see,
puppet-lintfound a number of problems with the manifest. Correct them, save the file, and rerunpuppet-lintto check that all is well. If so, you'll see no output:ubuntu@cookbook:~/puppet$ puppet-lint modules/admin/manifests/ntp.pp ubuntu@cookbook:~/puppet$
There's more...
You can find out more about puppet-lint at the website
The website lists each of the style checks in detail, and explains what the error messages mean and what to do about them.
Should you follow the Puppet style guide and, by extension, keep your code lint-clean? It's up to you, but here are a couple of things to think about:
- It makes sense to use some style conventions, especially when you're working collaboratively on code. Unless you and your colleagues can agree on standards for whitespace, tabs, quoting, alignment, and so on, your code will be messy and difficult to read or maintain.
- If you're choosing a set of style conventions to follow, the logical choice would be that issued by Puppet Labs and adopted by the community for use in public modules.
Having said that, it's possible to tell puppet-lint to ignore certain checks if you've chosen not to adopt them in your codebase. For example, if you don't want puppet-lint to warn you about code lines exceeding 80 characters, you can run puppet-lint with the following option:
puppet-lint --no-80chars-check
Run puppet-lint --help to see the complete list of check configuration commands.
- MySQL Admin Cookbook LITE: Configuration, Server Monitoring, Managing Users
- Authorware應用案例教程
- 中文版CorelDRAW X8基礎培訓教程（全彩版）
- Cinema 4D完全實戰技術手冊
- 中文版CorelDRAW X6基礎培訓教程（第2版）
- SolidWorks 2018快速入門及應用技巧
- 網店美工設計：Photoshop CC案例教程（視頻指導版）
- Vue 企業開發實戰
- Origin科技繪圖與數據分析
- 邊做邊學：CorelDRAW X6圖形設計案例教程（第2版）（微課版）
- Flash CS5動畫設計教程
- Ruby on Rails Web Mashup Projects
- 前端函數式演進
- Axure RP8原型設計圖解視頻教程（Web+App）
- Cinema 4D/After Effects/RealFlow 動態圖形設計案例解析