Skip to content
This repository has been archived by the owner on Jun 28, 2022. It is now read-only.

Fix datastore grpc doc class generation for python and ruby #716

Merged
merged 6 commits into from
Nov 7, 2016
+137 −12
Merged

Fix datastore grpc doc class generation for python and ruby #716

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
10c9f12
Fix datastore grpc doc class generation for python and ruby
Nov 3, 2016
d53c396
* Fix PROTO_LINK_PATTERN
Nov 3, 2016
6ac372d
Add unit tests for ProtoLink matching and Ruby/Python/NodeJS CommentF…
Nov 4, 2016
d3015de
Improve PROTO_LINK_PATTERN to avoid ambiguity
Nov 4, 2016
5833031
Add more comments in unit test cases
Nov 7, 2016
77c8684
Fix typo in comment
Nov 7, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions src/test/java/com/google/api/codegen/ProtoDocumentLinkTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,19 +23,25 @@

public class ProtoDocumentLinkTest {

/* ProtoLink in comments is defined as [display name][fully qualified name] */
@Test
public void testMatchProtoLink() {
Matcher m;
m = CommentPatterns.PROTO_LINK_PATTERN.matcher("[Shelf][google.example.library.v1.Shelf]");
Truth.assertThat(m.find()).isTrue();
// Fully qualified name can be empty
m = CommentPatterns.PROTO_LINK_PATTERN.matcher("[Shelf][]");
Truth.assertThat(m.find()).isTrue();
// Display name may contain special character '$'
m = CommentPatterns.PROTO_LINK_PATTERN.matcher("[$Shelf][]");
Truth.assertThat(m.find()).isTrue();
// Display name may NOT be empty
m = CommentPatterns.PROTO_LINK_PATTERN.matcher("[][abc]");

This comment was marked as spam.

Sign in to view

Truth.assertThat(m.find()).isFalse();
// Fully qualified name may NOT contain special character '$'
m = CommentPatterns.PROTO_LINK_PATTERN.matcher("[A-Za-z_$][A-Za-z_$0-9]");

This comment was marked as spam.

Sign in to view

This comment was marked as spam.

Sign in to view

This comment was marked as spam.

Sign in to view

Truth.assertThat(m.find()).isFalse();
// Fully qualified name many NOT be numbers only

This comment was marked as spam.

Sign in to view

This comment was marked as spam.

Sign in to view

m = CommentPatterns.PROTO_LINK_PATTERN.matcher("[Shelf][123]");
Truth.assertThat(m.find()).isFalse();
}
Expand All @@ -47,11 +53,13 @@ public void testRDocCommentFixer() {
Truth.assertThat(RDocCommentFixer.rdocify("[$Shelf][google.example.library.v1.Shelf]"))
.isEqualTo("$Shelf");

// Cloud link may contain special character '$'
Truth.assertThat(RDocCommentFixer.rdocify("[cloud docs!](/library/example/link)"))
.isEqualTo("{cloud docs!}[https://cloud.google.com/library/example/link]");
Truth.assertThat(RDocCommentFixer.rdocify("[cloud docs!](/library/example/link$)"))
.isEqualTo("{cloud docs!}[https://cloud.google.com/library/example/link$]");

// Absolute link may contain special character '$'
Truth.assertThat(RDocCommentFixer.rdocify("[not a cloud link](http://www.google.com)"))
.isEqualTo("{not a cloud link}[http://www.google.com]");
Truth.assertThat(RDocCommentFixer.rdocify("[not a cloud link](http://www.google.com$)"))
Expand All @@ -66,11 +74,13 @@ public void testPythonSphinxCommentFixer() {
PythonSphinxCommentFixer.sphinxify("[$Shelf][google.example.library.v1.Shelf]"))
.isEqualTo("``$Shelf``");

// Cloud link may contain special character '$'
Truth.assertThat(PythonSphinxCommentFixer.sphinxify("[cloud docs!](/library/example/link)"))
.isEqualTo("`cloud docs! <https://cloud.google.com/library/example/link>`_");
Truth.assertThat(PythonSphinxCommentFixer.sphinxify("[cloud docs!](/library/example/link$)"))
.isEqualTo("`cloud docs! <https://cloud.google.com/library/example/link$>`_");

// Absolute link may contain special character '$'
Truth.assertThat(
PythonSphinxCommentFixer.sphinxify("[not a cloud link](http://www.google.com)"))
.isEqualTo("`not a cloud link <http://www.google.com>`_");
Expand All @@ -86,11 +96,13 @@ public void testJSDocCommentFixer() {
Truth.assertThat(JSDocCommentFixer.jsdocify("[$Shelf][google.example.library.v1.Shelf]"))
.isEqualTo("{@link $Shelf}");

// Cloud link may contain special character '$'
Truth.assertThat(JSDocCommentFixer.jsdocify("[cloud docs!](/library/example/link)"))
.isEqualTo("[cloud docs!](https://cloud.google.com/library/example/link)");
Truth.assertThat(JSDocCommentFixer.jsdocify("[cloud docs!](/library/example/link$)"))
.isEqualTo("[cloud docs!](https://cloud.google.com/library/example/link$)");

// Absolute link may contain special character '$'
Truth.assertThat(JSDocCommentFixer.jsdocify("[not a cloud link](http://www.google.com)"))
.isEqualTo("[not a cloud link](http://www.google.com)");
Truth.assertThat(JSDocCommentFixer.jsdocify("[not a cloud link](http://www.google.com$)"))
Expand Down