Skip to content

Commit

Permalink
Add a simple test for rustdoc search index contents
Browse files Browse the repository at this point in the history
  • Loading branch information
SiegeLord committed Aug 27, 2014
1 parent bcb0717 commit 0db6f4c
Show file tree
Hide file tree
Showing 3 changed files with 79 additions and 0 deletions.
17 changes: 17 additions & 0 deletions src/test/run-make/rustdoc-search-index/Makefile
@@ -0,0 +1,17 @@
-include ../tools.mk

# FIXME ignore windows
ifndef IS_WINDOWS

source=index.rs

all:
$(HOST_RPATH_ENV) $(RUSTDOC) -w html -o $(TMPDIR)/doc $(source)
cp $(source) $(TMPDIR)
cp verify.sh $(TMPDIR)
$(call RUN,verify.sh) $(TMPDIR)

else
all:

endif
29 changes: 29 additions & 0 deletions src/test/run-make/rustdoc-search-index/index.rs
@@ -0,0 +1,29 @@
// Copyright 2014 The Rust Project Developers. See the COPYRIGHT
// file at the top-level directory of this distribution and at
// http://rust-lang.org/COPYRIGHT.
//
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
// option. This file may not be copied, modified, or distributed
// except according to those terms.

#![crate_name = "rustdoc_test"]

// In: Foo
pub use private::Foo;

mod private {
pub struct Foo;
impl Foo {
// In: test_method
pub fn test_method() {}
// Out: priv_method
fn priv_method() {}
}

pub trait PrivateTrait {
// Out: priv_method
fn trait_method() {}
}
}
33 changes: 33 additions & 0 deletions src/test/run-make/rustdoc-search-index/verify.sh
@@ -0,0 +1,33 @@
#!/bin/sh

source="$1/index.rs"
index="$1/doc/search-index.js"

if ! [ -e $index ]
then
echo "Could not find the search index (looked for $index)"
exit 1
fi

ins=$(grep -o 'In: .*' $source | sed 's/In: \(.*\)/\1/g')
outs=$(grep -o 'Out: .*' $source | sed 's/Out: \(.*\)/\1/g')

for p in $ins
do
if ! grep -q $p $index
then
echo "'$p' was erroneously excluded from search index."
exit 1
fi
done

for p in $outs
do
if grep -q $p $index
then
echo "'$p' was erroneously included in search index."
exit 1
fi
done

exit 0

16 comments on commit 0db6f4c

@bors
Copy link
Contributor

@bors bors commented on 0db6f4c Aug 28, 2014

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

saw approval from cmr
at SiegeLord@0db6f4c

@bors
Copy link
Contributor

@bors bors commented on 0db6f4c Aug 28, 2014

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

merging SiegeLord/rust/reexported_methods = 0db6f4c into auto

@bors
Copy link
Contributor

@bors bors commented on 0db6f4c Aug 28, 2014

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

SiegeLord/rust/reexported_methods = 0db6f4c merged ok, testing candidate = da9da328

@bors
Copy link
Contributor

@bors bors commented on 0db6f4c Aug 28, 2014

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No active merge of candidate 0db6f4c found, likely manual push to master

@bors
Copy link
Contributor

@bors bors commented on 0db6f4c Aug 28, 2014

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

merging SiegeLord/rust/reexported_methods = 0db6f4c into auto

@bors
Copy link
Contributor

@bors bors commented on 0db6f4c Aug 28, 2014

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

SiegeLord/rust/reexported_methods = 0db6f4c merged ok, testing candidate = e1a3a205

@bors
Copy link
Contributor

@bors bors commented on 0db6f4c Aug 28, 2014

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No active merge of candidate 0db6f4c found, likely manual push to master

@bors
Copy link
Contributor

@bors bors commented on 0db6f4c Aug 28, 2014

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

merging SiegeLord/rust/reexported_methods = 0db6f4c into auto

@bors
Copy link
Contributor

@bors bors commented on 0db6f4c Aug 28, 2014

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

SiegeLord/rust/reexported_methods = 0db6f4c merged ok, testing candidate = 6deeb80a

@bors
Copy link
Contributor

@bors bors commented on 0db6f4c Aug 29, 2014

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No active merge of candidate 0db6f4c found, likely manual push to master

@bors
Copy link
Contributor

@bors bors commented on 0db6f4c Aug 29, 2014

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

merging SiegeLord/rust/reexported_methods = 0db6f4c into auto

@bors
Copy link
Contributor

@bors bors commented on 0db6f4c Aug 29, 2014

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

SiegeLord/rust/reexported_methods = 0db6f4c merged ok, testing candidate = 51d0d06

@bors
Copy link
Contributor

@bors bors commented on 0db6f4c Aug 29, 2014

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fast-forwarding master to auto = 51d0d06

Please sign in to comment.