def test_consistent_duplicate(self):
"""Test that sorter detects consistent duplicates, keeps one, and warns."""
src_lines = [
u'#include "common/util.h"',
u'#include <algorithm>',
u'#include "mymath/factoiral.h"',
u'#include <algorithm>',
u'#include "foo/bar.h"',
u'',
]
exp_lines = [
u'#include "foo/bar.h"', # own include
u'',
u'#include <algorithm>', # C++ system
u'',
u'#include "common/util.h"', # Project
u'#include "mymath/factoiral.h"',
u'',
]
self.assertListEqual(
exp_lines,
nitpick.sort_includes('foo/bar.cc', src_lines),
)
self.assertListEqual(
[u'WARNING: "algorithm" included more than once (consistently) in '
'"foo/bar.cc:4": #include <algorithm>\n'],
self._stderr.buffer
)
def test_surrounding_lines(self):
"""Test that sorter doesn't mess with surrounding lines."""
src_lines = [
u'// Copyright message',
u'// By someone',
u'#include "common/util.h"',
u'#include <algorithm>',
u'#include "mymath/factoiral.h"',
u'#include "foo/bar.h"',
u'int main() {',
u' return 42;',
u'}',
u'',
]
exp_lines = [
u'// Copyright message',
u'// By someone',
u'#include "foo/bar.h"', # own include
u'',
u'#include <algorithm>', # C++ system
u'',
u'#include "common/util.h"', # Project
u'#include "mymath/factoiral.h"',
u'',
u'int main() {',
u' return 42;',
u'}',
u'',
]
self.assertListEqual(
exp_lines,
nitpick.sort_includes('foo/bar.cc', src_lines),
)
def test_with_root_dir(self):
"""Test that sorter understands the root option."""
nitpick._ROOT = 'proj'
src_lines = [
u'#include "common/util.h"',
u'#include <vector>',
u'#include "mymath/factoiral.h"',
u'#include <map>',
u'#include <algorithm>',
u'#include <stdio.h>',
u'#include "common/logging.h"',
u'#include "foo/bar.h"',
u'',
]
exp_lines = [
u'#include "foo/bar.h"', # own include
u'',
u'#include <stdio.h>', # C system
u'',
u'#include <algorithm>', # C++ system
u'#include <map>',
u'#include <vector>',
u'',
u'#include "common/logging.h"', # Project
u'#include "common/util.h"',
u'#include "mymath/factoiral.h"',
u'',
]
self.assertListEqual(
exp_lines,
nitpick.sort_includes('proj/foo/bar.cc', src_lines),
)
def test_ext_lib_sort(self):
"""Test that external lib includes are detected and sorted."""
src_lines = [
u'#include <gflags/gflags.h>',
u'#include <vector>',
u'#include "mymath/factoiral.h"',
u'#include <map>',
u'#include <algorithm>',
u'#include <stdio.h>',
u'#include <glog/logging.h>',
u'#include "foo/bar.h"',
u'',
]
exp_lines = [
u'#include "foo/bar.h"', # own include
u'',
u'#include <stdio.h>', # C system
u'',
u'#include <algorithm>', # C++ system
u'#include <map>',
u'#include <vector>',
u'',
u'#include <gflags/gflags.h>', # Ext libs
u'#include <glog/logging.h>',
u'',
u'#include "mymath/factoiral.h"', # Project
u'',
]
self.assertListEqual(
exp_lines,
nitpick.sort_includes('foo/bar.cc', src_lines),
)
def test_simple_sort(self):
"""Test that a straight forward sort is performed as expected."""
src_lines = [
u'#include "common/util.h"',
u'#include <vector>',
u'#include "mymath/factoiral.h"',
u'#include <map>',
u'#include <algorithm>',
u'#include <stdio.h>',
u'#include "common/logging.h"',
u'#include "foo/bar.h"',
u'',
]
exp_lines = [
u'#include "foo/bar.h"', # own include
u'',
u'#include <stdio.h>', # C system
u'',
u'#include <algorithm>', # C++ system
u'#include <map>',
u'#include <vector>',
u'',
u'#include "common/logging.h"', # Project
u'#include "common/util.h"',
u'#include "mymath/factoiral.h"',
u'',
]
self.assertListEqual(
exp_lines,
nitpick.sort_includes('foo/bar.cc', src_lines),
)
def test_simple_sort(self):
"""Test that a straight forward sort is performed as expected."""
src_lines = [
u'#include "common/util.h"',
u'#include <vector>',
u'#include "mymath/factoiral.h"',
u'#include <map>',
u'#include <algorithm>',
u'#include <stdio.h>',
u'#include "common/logging.h"',
u'#include "foo/bar.h"',
u'',
]
exp_lines = [
u'#include "foo/bar.h"', # own include
u'',
u'#include <stdio.h>', # C system
u'',
u'#include <algorithm>', # C++ system
u'#include <map>',
u'#include <vector>',
u'',
u'#include "common/logging.h"', # Project
u'#include "common/util.h"',
u'#include "mymath/factoiral.h"',
u'',
]
self.assertListEqual(
exp_lines,
nitpick.sort_includes('foo/bar.cc', src_lines),
)
def test_inconsistent_duplicate(self):
"""Test that sorter detects inconsistent duplicates, and breaks."""
src_lines = [
u'#include "common/util.h"',
u'#include <algorithm> // for std::max',
u'#include "mymath/factoiral.h"',
u'#include <algorithm>',
u'#include "foo/bar.h"',
u'',
]
with self.assertRaises(RuntimeError):
nitpick.sort_includes('foo/bar.cc', src_lines)
self.assertListEqual([
u'ERROR: "algorithm" included more than once (inconsistently) in '
'"foo/bar.cc:4": #include <algorithm>\n'
], self._stderr.buffer)
def test_wrong_include_style(self):
"""Test that sorter detects wrong include style and warns about it."""
src_lines = [
u'#include <common/util.h>',
u'#include "algorithm"',
u'#include "mymath/factoiral.h"',
u'#include "foo/bar.h"',
u'',
]
exp_lines = [
u'#include "foo/bar.h"',
u'',
u'#include <common/util.h>',
u'',
u'#include "algorithm"',
u'#include "mymath/factoiral.h"',
u'',
]
self.assertListEqual(
exp_lines,
nitpick.sort_includes('foo/bar.cc', src_lines),
)
self.assertListEqual([
u'WARNING: "common/util.h" looks like a project-file, but is included '
'with <> in "foo/bar.cc:1": #include <common/util.h>\n',
u'WARNING: "algorithm" looks like a system-file, but is included with '
'"" in "foo/bar.cc:2": #include "algorithm"\n'
], self._stderr.buffer)
def test_with_root_dir(self):
"""Test that sorter understands the root option."""
nitpick._ROOT = 'proj'
src_lines = [
u'#include "common/util.h"',
u'#include <vector>',
u'#include "mymath/factoiral.h"',
u'#include <map>',
u'#include <algorithm>',
u'#include <stdio.h>',
u'#include "common/logging.h"',
u'#include "foo/bar.h"',
u'',
]
exp_lines = [
u'#include "foo/bar.h"', # own include
u'',
u'#include <stdio.h>', # C system
u'',
u'#include <algorithm>', # C++ system
u'#include <map>',
u'#include <vector>',
u'',
u'#include "common/logging.h"', # Project
u'#include "common/util.h"',
u'#include "mymath/factoiral.h"',
u'',
]
self.assertListEqual(
exp_lines,
nitpick.sort_includes('proj/foo/bar.cc', src_lines),
)
def test_consistent_duplicate(self):
"""Test that sorter detects consistent duplicates, keeps one, and warns."""
src_lines = [
u'#include "common/util.h"',
u'#include <algorithm>',
u'#include "mymath/factoiral.h"',
u'#include <algorithm>',
u'#include "foo/bar.h"',
u'',
]
exp_lines = [
u'#include "foo/bar.h"', # own include
u'',
u'#include <algorithm>', # C++ system
u'',
u'#include "common/util.h"', # Project
u'#include "mymath/factoiral.h"',
u'',
]
self.assertListEqual(
exp_lines,
nitpick.sort_includes('foo/bar.cc', src_lines),
)
self.assertListEqual([
u'WARNING: "algorithm" included more than once (consistently) in '
'"foo/bar.cc:4": #include <algorithm>\n'
], self._stderr.buffer)
def test_surrounding_lines(self):
"""Test that sorter doesn't mess with surrounding lines."""
src_lines = [
u'// Copyright message',
u'// By someone',
u'#include "common/util.h"',
u'#include <algorithm>',
u'#include "mymath/factoiral.h"',
u'#include "foo/bar.h"',
u'int main() {',
u' return 42;',
u'}',
u'',
]
exp_lines = [
u'// Copyright message',
u'// By someone',
u'#include "foo/bar.h"', # own include
u'',
u'#include <algorithm>', # C++ system
u'',
u'#include "common/util.h"', # Project
u'#include "mymath/factoiral.h"',
u'',
u'int main() {',
u' return 42;',
u'}',
u'',
]
self.assertListEqual(
exp_lines,
nitpick.sort_includes('foo/bar.cc', src_lines),
)
def test_ext_lib_sort(self):
"""Test that external lib includes are detected and sorted."""
src_lines = [
u'#include <gflags/gflags.h>',
u'#include <vector>',
u'#include "mymath/factoiral.h"',
u'#include <map>',
u'#include <algorithm>',
u'#include <stdio.h>',
u'#include <glog/logging.h>',
u'#include "foo/bar.h"',
u'',
]
exp_lines = [
u'#include "foo/bar.h"', # own include
u'',
u'#include <stdio.h>', # C system
u'',
u'#include <algorithm>', # C++ system
u'#include <map>',
u'#include <vector>',
u'',
u'#include <gflags/gflags.h>', # Ext libs
u'#include <glog/logging.h>',
u'',
u'#include "mymath/factoiral.h"', # Project
u'',
]
self.assertListEqual(
exp_lines,
nitpick.sort_includes('foo/bar.cc', src_lines),
)
def test_wrong_include_style(self):
"""Test that sorter detects wrong include style and warns about it."""
src_lines = [
u'#include <common/util.h>',
u'#include "algorithm"',
u'#include "mymath/factoiral.h"',
u'#include "foo/bar.h"',
u'',
]
exp_lines = [
u'#include "foo/bar.h"',
u'',
u'#include <common/util.h>',
u'',
u'#include "algorithm"',
u'#include "mymath/factoiral.h"',
u'',
]
self.assertListEqual(
exp_lines,
nitpick.sort_includes('foo/bar.cc', src_lines),
)
self.assertListEqual(
[u'WARNING: "common/util.h" looks like a project-file, but is included '
'with <> in "foo/bar.cc:1": #include <common/util.h>\n',
u'WARNING: "algorithm" looks like a system-file, but is included with '
'"" in "foo/bar.cc:2": #include "algorithm"\n'],
self._stderr.buffer
)
def test_inconsistent_duplicate(self):
"""Test that sorter detects inconsistent duplicates, and breaks."""
src_lines = [
u'#include "common/util.h"',
u'#include <algorithm> // for std::max',
u'#include "mymath/factoiral.h"',
u'#include <algorithm>',
u'#include "foo/bar.h"',
u'',
]
with self.assertRaises(RuntimeError):
nitpick.sort_includes('foo/bar.cc', src_lines)
self.assertListEqual(
[u'ERROR: "algorithm" included more than once (inconsistently) in '
'"foo/bar.cc:4": #include <algorithm>\n'],
self._stderr.buffer
)
def test_preserve_poststr(self):
"""Test that the sort preserves post-strings of include lines."""
src_lines = [
u'#include <stdio.h> // old school',
u'#include\t<\tglog/logging.h\t>\t//for logging, ya know',
u'#include "foo/bar.h" // implemented interface',
u'',
]
exp_lines = [
u'#include "foo/bar.h" // implemented interface', # own include
u'',
u'#include <stdio.h> // old school', # C system
u'',
u'#include <glog/logging.h>\t//for logging, ya know', # Ext libs
u'',
]
self.assertListEqual(
exp_lines,
nitpick.sort_includes('foo/bar.cc', src_lines),
)
def test_preserve_poststr(self):
"""Test that the sort preserves post-strings of include lines."""
src_lines = [
u'#include <stdio.h> // old school',
u'#include\t<\tglog/logging.h\t>\t//for logging, ya know',
u'#include "foo/bar.h" // implemented interface',
u'',
]
exp_lines = [
u'#include "foo/bar.h" // implemented interface', # own include
u'',
u'#include <stdio.h> // old school', # C system
u'',
u'#include <glog/logging.h>\t//for logging, ya know', # Ext libs
u'',
]
self.assertListEqual(
exp_lines,
nitpick.sort_includes('foo/bar.cc', src_lines),
)
def test_nop_sort(self):
"""Test that already sorted includes returned as it."""
src_lines = [
u'#include "foo/bar.h"',
u'',
u'#include <stdio.h>',
u'',
u'#include <algorithm>',
u'#include <map>',
u'#include <vector>',
u'',
u'#include "common/logging.h"',
u'#include "common/util.h"',
u'#include "mymath/factoiral.h"',
u'',
]
self.assertListEqual(
src_lines,
nitpick.sort_includes('foo/bar.cc', src_lines),
)
def test_nop_sort(self):
"""Test that already sorted includes returned as it."""
src_lines = [
u'#include "foo/bar.h"',
u'',
u'#include <stdio.h>',
u'',
u'#include <algorithm>',
u'#include <map>',
u'#include <vector>',
u'',
u'#include "common/logging.h"',
u'#include "common/util.h"',
u'#include "mymath/factoiral.h"',
u'',
]
self.assertListEqual(
src_lines,
nitpick.sort_includes('foo/bar.cc', src_lines),
)