Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Run code snippets in ReindexDocumentationIT #32093

Closed
cbuescher opened this issue Jul 16, 2018 · 1 comment
Closed

Run code snippets in ReindexDocumentationIT #32093

cbuescher opened this issue Jul 16, 2018 · 1 comment
Assignees
@vladimirdolzhenko
Labels
:Distributed Indexing/CRUD A catch all label for issues around indexing, updating and getting a doc by id. Not search. >docs General docs changes >enhancement help wanted adoptme >test Issues or PRs that are addressing/adding tests

Comments

@cbuescher
Copy link
Member

cbuescher commented Jul 16, 2018 •
edited
Loading

Currently it seems we don't run any of the documentation code snippets in ReindexDocumentationIT.
Test methods don't start with the "test..." prefix, so we don't catch any errors in the documented code snippets other
than compile errors. I think the snippets should be run like in other code documentation tests. However this might
require some additional test setup code. Also I think the api responses require some basic assertions.
Otherwiew we miss errors like the one reported in #32010.
@cbuescher cbuescher added >enhancement >docs General docs changes >test Issues or PRs that are addressing/adding tests help wanted adoptme labels Jul 16, 2018
@cbuescher cbuescher mentioned this issue Jul 16, 2018
Merged
@cbuescher cbuescher added the :Distributed Indexing/CRUD A catch all label for issues around indexing, updating and getting a doc by id. Not search. label Jul 16, 2018
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-distributed

@vladimirdolzhenko vladimirdolzhenko self-assigned this Nov 1, 2018
vladimirdolzhenko pushed a commit to vladimirdolzhenko/elasticsearch that referenced this issue Nov 1, 2018
Run code snippets in ReindexDocumentationIT
1f23272 
Closes elastic#32093
@vladimirdolzhenko vladimirdolzhenko mentioned this issue Nov 1, 2018
Merged
vladimirdolzhenko added a commit that referenced this issue Nov 2, 2018
@vladimirdolzhenko
Run code snippets in ReindexDocumentationIT (#35165)
12072b2 
Closes #32093
vladimirdolzhenko added a commit that referenced this issue Nov 2, 2018
@vladimirdolzhenko
Run code snippets in ReindexDocumentationIT (#35165)
16c7bcc 
Closes #32093

(cherry picked from commit 12072b2)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@vladimirdolzhenko vladimirdolzhenko

Labels
:Distributed Indexing/CRUD A catch all label for issues around indexing, updating and getting a doc by id. Not search. >docs General docs changes >enhancement help wanted adoptme >test Issues or PRs that are addressing/adding tests
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@vladimirdolzhenko @cbuescher @elasticmachine