1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
|
# frozen_string_literal: true
require 'spec_helper'
describe 'Command test' do
xit 'works with as-links' do
output = make_bin('--as-links www.github.com,foofoofoo.biz')
expect(output).to match('1 failure')
end
xit 'works with alt-ignore' do
ignorable_links = "#{FIXTURES_DIR}/images/ignorable_alt_via_options.html"
output = make_bin("--alt-ignore /wikimedia/,gpl.png #{ignorable_links}")
expect(output).to match('successfully')
end
it 'works with checks-to-ignore' do
external = "#{FIXTURES_DIR}/links/file.foo"
output = make_bin("--extension .foo --checks-to-ignore 'LinkCheck' #{external}")
expect(output).to match('successfully')
expect(output).to_not match(/Running.+?LinkCheck/)
end
it 'works with check-external-hash' do
broken_hash_on_the_web = "#{FIXTURES_DIR}/links/broken_hash_on_the_web.html"
output = make_bin("--check-external-hash #{broken_hash_on_the_web}")
expect(output).to match('1 failure')
end
it 'works with directory-index-file' do
link_pointing_to_directory = "#{FIXTURES_DIR}/links/link_pointing_to_directory.html"
output = make_bin("--directory-index-file index.php #{link_pointing_to_directory}")
expect(output).to match('successfully')
end
it 'works with disable-external' do
external = "#{FIXTURES_DIR}/links/broken_link_external.html"
output = make_bin("--disable-external #{external}")
expect(output).to match('successfully')
end
xit 'works with extension' do
external = "#{FIXTURES_DIR}/links/file.foo"
output = make_bin("--extension .foo #{external}")
expect(output).to match('1 failure')
expect(output).to match('LinkCheck')
end
it 'works with file-ignore' do
external = "#{FIXTURES_DIR}/links/broken_hash_internal.html"
output = make_bin("--file-ignore #{external} #{external}")
expect(output).to match('successfully')
end
it 'works with internal-domains' do
translated_link = "#{FIXTURES_DIR}/links/link_translated_internal_domains.html"
output = make_bin("--internal-domains www.example.com,example.com #{translated_link}")
expect(output).to match('successfully')
end
it 'works with url-ignore' do
ignorable_links = "#{FIXTURES_DIR}/links/ignorable_links_via_options.html"
output = make_bin("--url-ignore /^http:\/\//,/sdadsad/,../whaadadt.html #{ignorable_links}")
expect(output).to match('successfully')
end
it 'works with url-swap' do
translated_link = "#{FIXTURES_DIR}/links/link_translated_via_href_swap.html"
output = make_bin(%|--url-swap "\\A/articles/([\\w-]+):\\1.html" #{translated_link}|)
expect(output).to match('successfully')
end
it 'works with url-swap and colon' do
translated_link = "#{FIXTURES_DIR}/links/link_translated_via_href_swap2.html"
output = make_bin(%(--url-swap "http\\://www.example.com:" #{translated_link}))
expect(output).to match('successfully')
end
xit 'works with only-4xx' do
broken_hash_on_the_web = "#{FIXTURES_DIR}/links/broken_hash_on_the_web.html"
output = make_bin("--only-4xx #{broken_hash_on_the_web}")
expect(output).to match('successfully')
end
it 'works with check-favicon' do
broken = "#{FIXTURES_DIR}/favicon/favicon_broken.html"
output = make_bin("--check-favicon #{broken}")
expect(output).to match('1 failure')
end
it 'works with check-html' do
broken = "#{FIXTURES_DIR}/html/missing_closing_quotes.html"
output = make_bin("--check-html --report-eof-tags #{broken}")
expect(output).to match('1 failure')
end
it 'works with empty-alt-ignore' do
broken = "#{FIXTURES_DIR}/images/empty_image_alt_text.html"
output = make_bin("--empty-alt-ignore #{broken}")
expect(output).to match('successfully')
end
it 'works with allow-hash-href' do
broken = "#{FIXTURES_DIR}/links/hash_href.html"
output = make_bin("--allow-hash-href #{broken}")
expect(output).to match('successfully')
end
# VCR doesn't work with bins, for some reason; parse STDOUT, ugh
skip 'has only one UA [does not work in CI]' do
http = make_bin(%|--typhoeus-config='{"verbose":true,"headers":{"User-Agent":"Mozilla/5.0 (Macintosh; My New User-Agent)"}}' --as-links https://linkedin.com|)
expect(http.scan(/User-Agent: Typhoeus/).count).to eq 0
expect(http.scan(%r{User-Agent: Mozilla/5.0 \(Macintosh; My New User-Agent\)}).count).to eq 2
end
it 'accepts hydra max_concurrency' do
http = make_bin(%(--hydra-config '{"max_concurrency": 5}' http://www.github.com --as-links))
expect(http.scan(/max_concurrency is invalid/).count).to eq 0
end
it 'navigates above itself in a subdirectory' do
real_link = "#{FIXTURES_DIR}/links/root_folder/documentation-from-my-project/"
output = make_bin("--root-dir #{FIXTURES_DIR}/links/root_folder/ #{real_link}")
expect(output).to match('successfully')
end
it 'has every option for proofer defaults' do
match_command_help(HTMLProofer::Configuration::PROOFER_DEFAULTS)
end
it 'has every option for validation defaults' do
match_command_help(HTMLProofer::Configuration::VALIDATION_DEFAULTS)
end
end
def match_command_help(config)
config_keys = config.keys
bin_file = File.read('bin/htmlproofer')
help_output = make_bin('--help')
readme = File.read('README.md')
config_keys.map(&:to_s).each do |key|
# match options
expect(bin_file).to match(key)
matched = false
readme.each_line do |line|
next unless /\| `#{key}`/.match?(line)
matched = true
description = line.split('|')[2].strip
description.gsub!('A hash', 'A comma-separated list')
description.gsub!('An array', 'A comma-separated list')
description.gsub!(/\[(.+?)\]\(.+?\)/, '\1')
description.sub!(/\.$/, '')
# match README description for option
expect(help_output).to include(description)
end
expect(matched).to be(true), "Could not find `#{key}` explained in README!" unless matched
end
end
|
