Checkmk git commits December 2017

checkmk-commits@lists.checkmk.com

10 participants
219 discussions

5352 agent_hivemanager_ng/hivemanager_ng_devices: new special agent and check

by Tom Baerwinkel

Module: check_mk Branch: master Commit: 730b7fafce5ac046c5f9c99ad649185b1589e913 URL: http://git.mathias-kettner.de/git/?p=check_mk.git;a=commit;h=730b7fafce5ac0… Author: Tom Baerwinkel <tb(a)mathias-kettner.de> Date: Fri Oct 20 10:33:44 2017 +0200 5352 agent_hivemanager_ng/hivemanager_ng_devices: new special agent and check Add the special agent agent_hivemanager_ng and the corresponding check hivemanager_ng_devices. Together they can be used to monitor devices in the Aerohive HiveManager NG cloud. Setup of the special agent is possible via the WATO rule "Aerohive HiveManager NG". For each device one check is created. The devices can be configured via the WATO rule "HiveManager NG Devices". Change-Id: If0b36911284dbdd97053df9a6da4c579779a07b9 --- .werks/5352 | 16 +++++ agents/special/agent_hivemanager_ng | 111 ++++++++++++++++++++++++++++++++ checkman/hivemanager_ng_devices | 17 +++++ checks/agent_hivemanager_ng | 41 ++++++++++++ checks/hivemanager_ng_devices | 105 ++++++++++++++++++++++++++++++ web/htdocs/valuespec.py | 2 +- web/plugins/wato/check_parameters.py | 23 +++++++ web/plugins/wato/datasource_programs.py | 50 ++++++++++++++ 8 files changed, 364 insertions(+), 1 deletion(-) Diff: http://git.mathias-kettner.de/git/?p=check_mk.git;a=commitdiff;h=730b7fafce…

6 years, 11 months

5523 df: Make filesystem types ignored during discovery configurable via WATO

by Konstantin Büttner

Module: check_mk Branch: master Commit: 0d5107c598a68a4824a9d7ebb560a0eedba88eb3 URL: http://git.mathias-kettner.de/git/?p=check_mk.git;a=commit;h=0d5107c598a68a… Author: Konstantin Büttner <kb(a)mathias-kettner.de> Date: Wed Nov 29 14:25:04 2017 +0100 5523 df: Make filesystem types ignored during discovery configurable via WATO Previously, the only way to influence the filesystem types to be ignored was by setting a config variable manually in a file, which would affect the behaviour globally. Now, this can be configured by a rule, allowing to include eg. tmpfs only for certain hosts. Change-Id: Ibae2bcbbddf4328f9b99e7964eeb62b934a723b4 --- .werks/5523 | 14 ++++++++++++++ checks/df | 5 ++++- tests/checks/test_df_check.py | 12 ++++++++++++ web/plugins/wato/check_parameters.py | 20 ++++++++++++++++++-- 4 files changed, 48 insertions(+), 3 deletions(-) diff --git a/.werks/5523 b/.werks/5523 new file mode 100644 index 0000000..946a504 --- /dev/null +++ b/.werks/5523 @@ -0,0 +1,14 @@ +Title: df: Make filesystem types ignored during discovery configurable via WATO +Level: 1 +Component: checks +Compatible: compat +Edition: cre +Version: 1.5.0i2 +Date: 1511961740 +Class: feature + +Previously, the only way to influence the filesystem types to be ignored was by +setting a config variable manually in a file, which would affect the behaviour +globally. Now, this can be configured by a rule, allowing to include e.g. tmpfs +only for certain hosts. Individual mountpoints can also be configured to be +discovered regardless of filesystem type. diff --git a/checks/df b/checks/df index d780799..0f26539 100644 --- a/checks/df +++ b/checks/df @@ -195,6 +195,9 @@ def inventory_df(parsed): inventory_options = host_extra_conf_merged(host_name(), inventory_df_rules) include_volume_name = inventory_options.get("include_volume_name", False) + ignore_fs_types = inventory_options.get("ignore_fs_types", inventory_df_exclude_fs) + never_ignore_mountpoints = inventory_options.get("never_ignore_mountpoints", []) + (df_blocks, volume_info), _ = parsed mplist = [] @@ -203,7 +206,7 @@ def inventory_df(parsed): mountpoint = line[0] if mountpoint in inventory_df_exclude_mountpoints: continue # exclude this mount point (/tmp, /proc, whatever user wants) - if volume_info[mountpoint]["fs_type"] in inventory_df_exclude_fs: + if volume_info[mountpoint]["fs_type"] in ignore_fs_types and mountpoint not in never_ignore_mountpoints: continue # ignore this filesystem type mplist.append(mountpoint) diff --git a/tests/checks/test_df_check.py b/tests/checks/test_df_check.py index b2cf847..5bc8ccd 100644 --- a/tests/checks/test_df_check.py +++ b/tests/checks/test_df_check.py @@ -47,6 +47,7 @@ info_df_lnx_tmpfs = [[u'tmpfs', u'8152744', u'1%', u'/opt/omd/sites/heute/tmp'], + [u'tmpfs', u'tmpfs', u'8152840', u'118732', u'8034108', u'2%', u'/dev/shm'], [u'[df_inodes_start]'], [u'tmpfs', u'tmpfs', @@ -55,6 +56,7 @@ info_df_lnx_tmpfs = [[u'tmpfs', u'2038157', u'1%', u'/opt/omd/sites/heute/tmp'], + [u'tmpfs', u'tmpfs', u'2038210', u'57', u'2038153', u'1%', u'/dev/shm'], [u'[df_inodes_end]']] # NOTE: This gargantuan test info section is uncritically used data from an archived agent output. @@ -224,6 +226,16 @@ info_df_btrfs = \ (info_df_win, [(u'New_Volume E:/', {}), (u'New_Volume F:/', {}), (u'C:\\ C:/', {})], { "include_volume_name" : True }), # Windows w/ volume name option (info_df_lnx_tmpfs, [], {}), # Ignoring tmpfs + (info_df_lnx_tmpfs, [], { "ignore_fs_types" : [ 'tmpfs', 'nfs', 'smbfs', 'cifs', 'iso9660' ] }), # Ignoring tmpfs explicitly + (info_df_lnx_tmpfs, [(u'/opt/omd/sites/heute/tmp', {})], + { "ignore_fs_types" : [ 'tmpfs', 'nfs', 'smbfs', 'cifs', 'iso9660' ], # Ignoring tmpfs explicitly, but + "never_ignore_mountpoints" : [ u'/opt/omd/sites/heute/tmp' ]}), # including one mountpoint explicitly + (info_df_lnx_tmpfs, [(u'/opt/omd/sites/heute/tmp', {}), (u'/dev/shm', {})], + { "ignore_fs_types" : [ 'nfs', 'smbfs', 'cifs', 'iso9660' ] }), # Including tmpfs + + (info_df_lnx_tmpfs, [(u'tmpfs /opt/omd/sites/heute/tmp', {}), (u'tmpfs /dev/shm', {})], + { "ignore_fs_types" : [ 'nfs', 'smbfs', 'cifs', 'iso9660' ], + "include_volume_name" : True}), # Including tmpfs and volume name (info_df_btrfs, [(u'/sys/fs/cgroup', {}), (u'btrfs /dev/sda1', {})], {}), # btrfs (info_df_btrfs, [(u'/dev/sda1 /sys/fs/cgroup', {}), (u'/dev/sda1 btrfs /dev/sda1', {})], { "include_volume_name" : True }), # btrfs w/ volume name option diff --git a/web/plugins/wato/check_parameters.py b/web/plugins/wato/check_parameters.py index bb6562d..22e04f8 100644 --- a/web/plugins/wato/check_parameters.py +++ b/web/plugins/wato/check_parameters.py @@ -1549,14 +1549,30 @@ register_rule(group + '/' + subgroup_inventory, register_rule(group + '/' + subgroup_inventory, varname = "inventory_df_rules", - title = _("Include Volume name in Filesystem Checks"), + title = _("Discovery parameters for filesystem checks"), valuespec = Dictionary( elements = [ ("include_volume_name", Checkbox( title = _("Include Volume name in item") )), + ("ignore_fs_types", ListChoice( + title = _("Filesystem types to ignore"), + choices = [ + ("tmpfs", "tmpfs"), + ("nfs", "nfs"), + ("smbfs", "smbfs"), + ("cifs", "cifs"), + ("iso9660", "iso9660"), + ], + default_value = [ "tmpfs", "nfs", "smbfs", "cifs", "iso9660" ] + )), + ("never_ignore_mountpoints", ListOf( + TextUnicode(), + title = _(u"Mountpoints to never ignore"), + help =_(u"Regardless of filesystem type, these mountpoints will always be discovered." + u"Globbing or regular expressions are currently not supported."), + )), ], - optional_keys = [] ), match = "dict", )

6 years, 11 months

A few mechanical clang-tidy fixes.

by Sven Panne

Module: check_mk Branch: master Commit: 8d7324774e8bc243af422e95deeb8325bd659227 URL: http://git.mathias-kettner.de/git/?p=check_mk.git;a=commit;h=8d7324774e8bc2… Author: Sven Panne <sp(a)mathias-kettner.de> Date: Thu Dec 7 09:31:30 2017 +0100 A few mechanical clang-tidy fixes. Change-Id: I8d22f7d87904eccd89c029dfd6c42c1fb3c955c2 --- .clang-tidy | 3 ++- livestatus/src/HostListStateColumn.cc | 2 +- livestatus/src/OffsetTimeColumn.cc | 2 +- 3 files changed, 4 insertions(+), 3 deletions(-) diff --git a/.clang-tidy b/.clang-tidy index 6aa4984..ec71d61 100644 --- a/.clang-tidy +++ b/.clang-tidy @@ -11,6 +11,7 @@ # * undesirable checks: # * cppcoreguidelines-pro-type-static-cast-downcast ("do not use static_cast to downcast from a base to a derived class; use dynamic_cast instead") # * google-runtime-references ("non-const reference parameter 'foo', make it const or use a pointer") +# * hicpp-no-assembler ("do not use inline assembler in safety-critical code") triggered by ntohs/htons # * llvm-include-order ("#includes are not sorted properly") # # * desirable checks, but hard to fix currently: @@ -26,7 +27,7 @@ # * cppcoreguidelines-pro-type-union-access ("do not access members of unions; use (boost::)variant instead") # * modernize-use-bool-literals ("converting integer literal to bool, use bool literal instead") Incorrectly triggered by e.g. FD_ZERO # -Checks: '*,-cert-env33-c,-cert-err34-c,-cert-err58-cpp,-clang-analyzer-alpha*,-cppcoreguidelines-pro-bounds-array-to-pointer-decay,-cppcoreguidelines-pro-bounds-constant-array-index,-cppcoreguidelines-pro-bounds-pointer-arithmetic,-cppcoreguidelines-pro-type-const-cast,-cppcoreguidelines-pro-type-member-init,-cppcoreguidelines-pro-type-reinterpret-cast,-cppcoreguidelines-pro-type-static-cast-downcast,-cppcoreguidelines-pro-type-union-access,-cppcoreguidelines-pro-type-vararg,-google-runtime-int,-google-runtime-references,-hicpp-member-init,-llvm-include-order,-modernize-use-bool-literals' +Checks: '*,-cert-env33-c,-cert-err34-c,-cert-err58-cpp,-clang-analyzer-alpha*,-cppcoreguidelines-pro-bounds-array-to-pointer-decay,-cppcoreguidelines-pro-bounds-constant-array-index,-cppcoreguidelines-pro-bounds-pointer-arithmetic,-cppcoreguidelines-pro-type-const-cast,-cppcoreguidelines-pro-type-member-init,-cppcoreguidelines-pro-type-reinterpret-cast,-cppcoreguidelines-pro-type-static-cast-downcast,-cppcoreguidelines-pro-type-union-access,-cppcoreguidelines-pro-type-vararg,-google-runtime-int,-google-runtime-references,-hicpp-member-init,-hicpp-no-assembler,-llvm-include-order,-modernize-use-bool-literals' CheckOptions: - key: google-readability-namespace-comments.SpacesBeforeComments value: '1' diff --git a/livestatus/src/HostListStateColumn.cc b/livestatus/src/HostListStateColumn.cc index 1f377da..a8a95ba 100644 --- a/livestatus/src/HostListStateColumn.cc +++ b/livestatus/src/HostListStateColumn.cc @@ -63,7 +63,7 @@ void HostListStateColumn::update(host *hst, const contact *auth_user, #ifdef CMC ServiceListStateColumn::service_list services = &hst->_services; bool has_been_checked = hst->state()->_has_been_checked; - int current_state = static_cast<int>(hst->state()->_current_state); + auto current_state = static_cast<int>(hst->state()->_current_state); #else ServiceListStateColumn::service_list services = hst->services; bool has_been_checked = hst->has_been_checked != 0; diff --git a/livestatus/src/OffsetTimeColumn.cc b/livestatus/src/OffsetTimeColumn.cc index e3d0a87..22c39e6 100644 --- a/livestatus/src/OffsetTimeColumn.cc +++ b/livestatus/src/OffsetTimeColumn.cc @@ -31,5 +31,5 @@ std::chrono::system_clock::time_point OffsetTimeColumn::getRawValue( if (auto p = columnData<time_t>(row)) { return std::chrono::system_clock::from_time_t(*p); } - return std::chrono::system_clock::time_point(); + return {}; }

6 years, 11 months

Remove confusing comment

by Konstantin Büttner

Module: check_mk Branch: master Commit: c2c1b42417b16f8d72a918c5b2f4de30e6197429 URL: http://git.mathias-kettner.de/git/?p=check_mk.git;a=commit;h=c2c1b42417b16f… Author: Konstantin Büttner <kb(a)mathias-kettner.de> Date: Thu Dec 7 09:31:57 2017 +0100 Remove confusing comment Change-Id: I1adf39694c76884ee3b47363916e8440225341da --- checks/statgrab_cpu | 1 - 1 file changed, 1 deletion(-) diff --git a/checks/statgrab_cpu b/checks/statgrab_cpu index 0132277..0c5111e 100644 --- a/checks/statgrab_cpu +++ b/checks/statgrab_cpu @@ -51,7 +51,6 @@ def check_statgrab_cpu(_no_item, params, info): # user, nice, system, idle, iowait, hw-int, sw-int, steal values = [ user, nice, system, idle, wait, 0, 0, 0 ] - # No return cause of the use of yield return check_cpu_util_unix(values, params)

6 years, 11 months

5481 Host-specific Check_MK agent TCP connect timeouts

by Tom Baerwinkel

Module: check_mk Branch: master Commit: f928da9ba3192de6468a270d32b4f68e94863b40 URL: http://git.mathias-kettner.de/git/?p=check_mk.git;a=commit;h=f928da9ba3192d… Author: Tom Baerwinkel <tb(a)mathias-kettner.de> Date: Mon Dec 4 17:16:44 2017 +0100 5481 Host-specific Check_MK agent TCP connect timeouts The time for TCP connect timeouts of the Check_MK agent can now be defined on a per-host-basis using the WATO ruleset "Agent TCP connect timeout". Change-Id: I000d2ab43ec5b8ab9cf2a12a72968f888e0d11f5 --- .werks/5481 | 12 +++++ bin/mkbench | 72 +++++++++++++++++------------- cmk_base/automations/check_mk.py | 14 +++--- cmk_base/config.py | 8 ++++ cmk_base/data_sources/tcp.py | 15 ++++++- cmk_base/default_config/base.py | 1 + web/htdocs/js/wato.js | 1 + web/htdocs/wato.py | 29 ++++++++---- web/plugins/wato/check_mk_configuration.py | 25 +++++++++-- 9 files changed, 127 insertions(+), 50 deletions(-) Diff: http://git.mathias-kettner.de/git/?p=check_mk.git;a=commitdiff;h=f928da9ba3…

6 years, 11 months

Fixed typos.

by Sven Panne

Module: check_mk Branch: master Commit: 2e994fd25c3f60ab96d2c4e2ca9fd308ef9177fa URL: http://git.mathias-kettner.de/git/?p=check_mk.git;a=commit;h=2e994fd25c3f60… Author: Sven Panne <sp(a)mathias-kettner.de> Date: Wed Dec 6 22:36:05 2017 +0100 Fixed typos. Change-Id: Ie9914bc5928f98a4f76516c68b5d17a71e19cd0a --- livestatus/src/PerfdataAggregator.cc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/livestatus/src/PerfdataAggregator.cc b/livestatus/src/PerfdataAggregator.cc index 3e3e337..3a2e334 100644 --- a/livestatus/src/PerfdataAggregator.cc +++ b/livestatus/src/PerfdataAggregator.cc @@ -22,7 +22,7 @@ // to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, // Boston, MA 02110-1301 USA. -// IWYU pragma: no_include <type_traits.h> +// IWYU pragma: no_include <type_traits> #include "PerfdataAggregator.h" #include <cmath> #include <functional>

6 years, 11 months

Tiny IWYU tweaks.

by Sven Panne

Module: check_mk Branch: master Commit: e12790b2a2a038c310cb008b06edf241cd803ead URL: http://git.mathias-kettner.de/git/?p=check_mk.git;a=commit;h=e12790b2a2a038… Author: Sven Panne <sp(a)mathias-kettner.de> Date: Wed Dec 6 22:15:24 2017 +0100 Tiny IWYU tweaks. Change-Id: Ia9eb2d8e6754b068e8db0ea438e47da15ba3f141 --- livestatus/src/PerfdataAggregator.cc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/livestatus/src/PerfdataAggregator.cc b/livestatus/src/PerfdataAggregator.cc index f1b6329..3e3e337 100644 --- a/livestatus/src/PerfdataAggregator.cc +++ b/livestatus/src/PerfdataAggregator.cc @@ -22,13 +22,13 @@ // to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, // Boston, MA 02110-1301 USA. +// IWYU pragma: no_include <type_traits.h> #include "PerfdataAggregator.h" #include <cmath> #include <functional> #include <iterator> #include <sstream> #include <stdexcept> -#include <type_traits> #include <utility> #include "Renderer.h" #include "Row.h"

6 years, 11 months

IWYU fixes.

by Sven Panne

Module: check_mk Branch: master Commit: 7f35fb4dd05b4c45112d5b51dd8d03d4b83f9713 URL: http://git.mathias-kettner.de/git/?p=check_mk.git;a=commit;h=7f35fb4dd05b4c… Author: Sven Panne <sp(a)mathias-kettner.de> Date: Wed Dec 6 18:30:41 2017 +0100 IWYU fixes. Change-Id: I39a880ce183c8c125c915e8fb369b3ab5e0ce032 --- livestatus/src/ClientQueue.cc | 1 - livestatus/src/Column.h | 3 ++- livestatus/src/CustomVarsDictFilter.cc | 3 +-- livestatus/src/DowntimeOrComment.h | 2 +- livestatus/src/EventConsoleConnection.cc | 4 +--- livestatus/src/HostSpecialDoubleColumn.cc | 5 +---- livestatus/src/InputBuffer.cc | 1 + livestatus/src/LogCache.cc | 1 + livestatus/src/Logfile.h | 2 +- livestatus/src/Logger.h | 4 ++-- livestatus/src/OffsetBoolColumn.h | 2 +- livestatus/src/OffsetIntColumn.h | 2 +- livestatus/src/OffsetStringHostMacroColumn.h | 2 +- livestatus/src/OffsetStringMacroColumn.cc | 1 + livestatus/src/OffsetStringServiceMacroColumn.h | 2 +- livestatus/src/PerfdataAggregator.cc | 3 +-- livestatus/src/Query.cc | 6 ++---- livestatus/src/Store.cc | 5 +++-- livestatus/src/StringUtils.cc | 3 +-- livestatus/src/Table.cc | 3 +-- livestatus/src/TableEventConsole.h | 1 - livestatus/src/TableLog.h | 2 +- livestatus/src/TimeColumn.cc | 2 -- livestatus/src/TimeperiodColumn.h | 2 +- livestatus/src/TimeperiodsCache.cc | 2 +- livestatus/src/module.cc | 3 ++- tests/iwyu-mappings/check_mk.imp | 4 +++- 27 files changed, 32 insertions(+), 39 deletions(-) Diff: http://git.mathias-kettner.de/git/?p=check_mk.git;a=commitdiff;h=7f35fb4dd0…

6 years, 11 months

Moved IWYU mappings to separate subdirectory.

by Sven Panne

Module: check_mk Branch: master Commit: 469a65a9640c29cd05d695cb09a6894a787bdfc7 URL: http://git.mathias-kettner.de/git/?p=check_mk.git;a=commit;h=469a65a9640c29… Author: Sven Panne <sp(a)mathias-kettner.de> Date: Wed Dec 6 10:15:35 2017 +0100 Moved IWYU mappings to separate subdirectory. Change-Id: If00c10c2f6b68c4860fbe8bb03810f35ebfa628b --- Makefile | 2 +- tests/{ => iwyu-mappings}/boost-all-private.imp | 0 tests/{ => iwyu-mappings}/boost-all.imp | 0 tests/{ => iwyu-mappings}/check_mk.imp | 0 4 files changed, 1 insertion(+), 1 deletion(-) diff --git a/Makefile b/Makefile index 4d4723b..2ebb43b 100644 --- a/Makefile +++ b/Makefile @@ -488,7 +488,7 @@ tidy: compile_commands.json # Not really perfect rules, but better than nothing iwyu: compile_commands.json - @$(IWYU_TOOL) --output-format=clang -p . -- --mapping_file=$(realpath tests/check_mk.imp) + @$(IWYU_TOOL) --output-format=clang -p . -- --mapping_file=$(realpath tests/iwyu-mappings/check_mk.imp) # Not really perfect rules, but better than nothing analyze: config.h diff --git a/tests/boost-all-private.imp b/tests/iwyu-mappings/boost-all-private.imp similarity index 100% rename from tests/boost-all-private.imp rename to tests/iwyu-mappings/boost-all-private.imp diff --git a/tests/boost-all.imp b/tests/iwyu-mappings/boost-all.imp similarity index 100% rename from tests/boost-all.imp rename to tests/iwyu-mappings/boost-all.imp diff --git a/tests/check_mk.imp b/tests/iwyu-mappings/check_mk.imp similarity index 100% rename from tests/check_mk.imp rename to tests/iwyu-mappings/check_mk.imp

6 years, 11 months

Nowadays we can use the system iwyu_tool.

by Sven Panne

Module: check_mk Branch: master Commit: f7bb1ab0118ecf0e65b851de234deed18af5ba72 URL: http://git.mathias-kettner.de/git/?p=check_mk.git;a=commit;h=f7bb1ab0118ecf… Author: Sven Panne <sp(a)mathias-kettner.de> Date: Wed Dec 6 10:13:15 2017 +0100 Nowadays we can use the system iwyu_tool. Change-Id: I60cbb6bc78b14713b97462e6f31ec6768c07fcb8 --- Makefile | 2 +- tests/iwyu_tool_jenkins.py | 222 --------------------------------------------- 2 files changed, 1 insertion(+), 223 deletions(-) diff --git a/Makefile b/Makefile index 08f8f05..4d4723b 100644 --- a/Makefile +++ b/Makefile @@ -73,7 +73,7 @@ CLANG_TIDY := clang-tidy-$(CLANG_VERSION) SCAN_BUILD := scan-build-$(CLANG_VERSION) CPPCHECK := cppcheck DOXYGEN := doxygen -IWYU_TOOL := tests/iwyu_tool_jenkins.py +IWYU_TOOL := iwyu_tool # The Bear versions have a slightly tragic history: Due to the clang bug # https://llvm.org/bugs/show_bug.cgi?id=24710 we need absolute paths in our diff --git a/tests/iwyu_tool_jenkins.py b/tests/iwyu_tool_jenkins.py deleted file mode 100755 index 19de45b..0000000 --- a/tests/iwyu_tool_jenkins.py +++ /dev/null @@ -1,222 +0,0 @@ -#!/usr/bin/env python - -""" Driver to consume a Clang compilation database and invoke IWYU. - -Example usage with CMake: - - # Unix systems - $ mkdir build && cd build - $ CC="clang" CXX="clang++" cmake -DCMAKE_EXPORT_COMPILE_COMMANDS=ON ... - $ iwyu_tool.py -p . - - # Windows systems - $ mkdir build && cd build - $ cmake -DCMAKE_CXX_COMPILER="%VCINSTALLDIR%/bin/cl.exe" \ - -DCMAKE_C_COMPILER="%VCINSTALLDIR%/VC/bin/cl.exe" \ - -DCMAKE_EXPORT_COMPILE_COMMANDS=ON \ - -G Ninja ... - $ python iwyu_tool.py -p . - -See iwyu_tool.py -h for more details on command-line arguments. -""" - -import os -import sys -import json -import argparse -import subprocess -import re - - -def iwyu_formatter(output): - """ Process iwyu's output, basically a no-op. """ - print('\n'.join(output)) - - -CORRECT_RE = re.compile(r'^$(.*?) has correct #includes/fwd-decls$$') -SHOULD_ADD_RE = re.compile(r'^(.*?) should add these lines:$') -SHOULD_REMOVE_RE = re.compile(r'^(.*?) should remove these lines:$') -FULL_LIST_RE = re.compile(r'The full include-list for (.*?):$') -END_RE = re.compile(r'^---$') -LINES_RE = re.compile(r'^- (.*?) // lines ([0-9]+)-[0-9]+$') - - -GENERAL, ADD, REMOVE, LIST = range(4) - - -def clang_formatter(output): - """ Process iwyu's output into something clang-like. """ - state = (GENERAL, None) - for line in output: - match = CORRECT_RE.match(line) - if match: - print('%s:1:1: note: #includes/fwd-decls are correct' % match.groups(1)) - continue - match = SHOULD_ADD_RE.match(line) - if match: - state = (ADD, match.group(1)) - continue - match = SHOULD_REMOVE_RE.match(line) - if match: - state = (REMOVE, match.group(1)) - continue - match = FULL_LIST_RE.match(line) - if match: - state = (LIST, match.group(1)) - elif END_RE.match(line): - state = (GENERAL, None) - elif not line.strip(): - continue - elif state[0] == GENERAL: - print(line) - elif state[0] == ADD: - print('%s:1:1: error: add the following line' % state[1]) - print(line) - elif state[0] == REMOVE: - match = LINES_RE.match(line) - line_no = match.group(2) if match else '1' - print('%s:%s:1: error: remove the following line' % (state[1], line_no)) - print(match.group(1)) - - -DEFAULT_FORMAT = 'iwyu' -FORMATTERS = { - 'iwyu': iwyu_formatter, - 'clang': clang_formatter -} - -def get_output(cwd, command): - """ Run the given command and return its output as a string. """ - process = subprocess.Popen(command, - cwd=cwd, - shell=True, - stdout=subprocess.PIPE, - stderr=subprocess.STDOUT) - return process.communicate()[0].decode("utf-8").splitlines() - - -def run_iwyu(cwd, compile_command, iwyu_args, verbose, formatter): - """ Rewrite compile_command to an IWYU command, and run it. """ - compiler, _, args = compile_command.partition(' ') - if compiler.endswith('cl.exe'): - # If the compiler name is cl.exe, let IWYU be cl-compatible - clang_args = ['--driver-mode=cl'] - else: - clang_args = [] - - iwyu_args = ['-Xiwyu ' + a for a in iwyu_args] - command = ['include-what-you-use'] + clang_args + iwyu_args - command = '%s %s' % (' '.join(command), args.strip()) - - if verbose: - print('%s:' % command) - - formatter(get_output(cwd, command)) - - -def main(compilation_db_path, source_files, verbose, formatter, iwyu_args): - """ Entry point. """ - # Canonicalize compilation database path - if os.path.isdir(compilation_db_path): - compilation_db_path = os.path.join(compilation_db_path, - 'compile_commands.json') - - compilation_db_path = os.path.realpath(compilation_db_path) - if not os.path.isfile(compilation_db_path): - print('ERROR: No such file or directory: \'%s\'' % compilation_db_path) - return 1 - - # Read compilation db from disk - with open(compilation_db_path, 'r') as fileobj: - compilation_db = json.load(fileobj) - - # expand symlinks - for entry in compilation_db: - entry['file'] = os.path.realpath(entry['file']) - - # Cross-reference source files with compilation database - source_files = [os.path.realpath(s) for s in source_files] - if not source_files: - # No source files specified, analyze entire compilation database - entries = compilation_db - else: - # Source files specified, analyze the ones appearing in compilation db, - # warn for the rest. - entries = [] - for source in source_files: - matches = [e for e in compilation_db if e['file'] == source] - if matches: - entries.extend(matches) - else: - print('WARNING: \'%s\' not found in compilation database.' % - source) - - # Run analysis - try: - for entry in entries: - cwd, compile_command = entry['directory'], entry['command'] - run_iwyu(cwd, compile_command, iwyu_args, verbose, formatter) - except OSError as why: - print('ERROR: Failed to launch include-what-you-use: %s' % why) - return 1 - - return 0 - - -def _bootstrap(): - """ Parse arguments and dispatch to main(). """ - # This hackery is necessary to add the forwarded IWYU args to the - # usage and help strings. - def customize_usage(parser): - """ Rewrite the parser's format_usage. """ - original_format_usage = parser.format_usage - parser.format_usage = lambda: original_format_usage().rstrip() + \ - ' -- [<IWYU args>]' + os.linesep - - def customize_help(parser): - """ Rewrite the parser's format_help. """ - original_format_help = parser.format_help - - def custom_help(): - """ Customized help string, calls the adjusted format_usage. """ - helpmsg = original_format_help() - helplines = helpmsg.splitlines() - helplines[0] = parser.format_usage().rstrip() - return os.linesep.join(helplines) + os.linesep - - parser.format_help = custom_help - - # Parse arguments - parser = argparse.ArgumentParser( - description='Include-what-you-use compilation database driver.', - epilog='Assumes include-what-you-use is available on the PATH.') - customize_usage(parser) - customize_help(parser) - - parser.add_argument('-v', '--verbose', action='store_true', - help='Print IWYU commands') - parser.add_argument('-o', '--output-format', type=str, - choices=FORMATTERS.keys(), default=DEFAULT_FORMAT, - help='Output format (default: %s)' % DEFAULT_FORMAT) - parser.add_argument('-p', metavar='<build-path>', required=True, - help='Compilation database path', dest='dbpath') - parser.add_argument('source', nargs='*', - help='Zero or more source files to run IWYU on. ' - 'Defaults to all in compilation database.') - - def partition_args(argv): - """ Split around '--' into driver args and IWYU args. """ - try: - double_dash = argv.index('--') - return argv[:double_dash], argv[double_dash+1:] - except ValueError: - return argv, [] - argv, iwyu_args = partition_args(sys.argv[1:]) - args = parser.parse_args(argv) - - sys.exit(main(args.dbpath, args.source, args.verbose, - FORMATTERS[args.output_format], iwyu_args)) - - -if __name__ == '__main__': - _bootstrap()

6 years, 11 months

← Newer
1
...
15
16
17
18
19
20
21
22
Older →

Jump to page:

2024

2023

2022

2021

2020

2019

2018

2017

2016

2015

2014

2013

2012

2011

2010

Checkmk git commits December 2017