Skip to content

Doclet Type detection fix + tests #202

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

Merged
jonpryor merged 16 commits into from
Oct 27, 2017
Merged

Doclet Type detection fix + tests #202

Show file tree
Hide file tree
Changes from 13 commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
effd0da
Fix doclet type detection
Redth Oct 26, 2017
50d123c
Assign DocletType to be readable
Redth Oct 26, 2017
97031e6
Bytecode Tests - Load resource to temp file helper
Redth Oct 26, 2017
675ed94
Bytecode Tests - added doclet type assertion
Redth Oct 26, 2017
60f154e
Bytecode Tests - fix code formatting on old test
Redth Oct 26, 2017
99b4e87
Bytecode Tests - add doclet type resolution tests
Redth Oct 26, 2017
3538b7a
Revert back to DocletType ?? GetDocletType (..)
Redth Oct 26, 2017
fde965e
Change DocletType Assertion, invoke GetDocletType
Redth Oct 26, 2017
d2d85a3
Bytecode tests - delete temp file in finally
Redth Oct 26, 2017
8301bf6
Bytecode tests - doc type is implicit
Redth Oct 26, 2017
21e82d3
Bytecode tests - remove unnecssary try/catch
Redth Oct 26, 2017
f050780
Move GetDocletType to AndroidDocScraper
Redth Oct 26, 2017
fef5efe
Bytecode Tests - remove unnecessary try/catch
Redth Oct 26, 2017
b975f8e
Fix formatting { got autoformatted to new line
Redth Oct 27, 2017
f1b0ba7
class-parse docsType should be null by default
Redth Oct 27, 2017
937297a
Remove DocletType and auto detect always
Redth Oct 27, 2017
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
31 changes: 1 addition & 30 deletions src/Xamarin.Android.Tools.Bytecode/ClassPath.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -233,38 +233,9 @@ void FixupParametersFromDocs (XElement api)
}
}

JavaDocletType GetDocletType (string path)
{
var kind = JavaDocletType.DroidDoc;
char [] buf = new char [500];
string packagesHtml = Path.Combine (path, "packages.html");
if (File.Exists (packagesHtml) && File.ReadAllText (packagesHtml).Contains ("<body class=\"gc-documentation develop reference api "))
kind = JavaDocletType.DroidDoc2;
using (var reader = File.OpenText (Path.Combine (path, "index.html")))
reader.ReadBlock (buf, 0, buf.Length);
string rawHTML = new string (buf);
if (rawHTML.Contains ("Generated by javadoc (build 1.6"))
kind = JavaDocletType.Java6;
else if (rawHTML.Contains ("Generated by javadoc (version 1.7"))
kind = JavaDocletType.Java7;
else if (rawHTML.Contains ("Generated by javadoc (1.8"))
kind = JavaDocletType.Java8;

// Check to see if it's an api.xml formatted doc
string rawXML = null;
using (var reader = File.OpenText (path)) {
int len = reader.ReadBlock (buf, 0, buf.Length);
rawXML = new string (buf, 0, len);
}
if (rawXML.Contains ("<api>") && rawXML.Contains ("<package"))
kind = JavaDocletType._ApiXml;

return kind;
}

IAndroidDocScraper CreateDocScraper (string src)
{
switch (DocletType ?? GetDocletType (src)) {
switch (DocletType ?? AndroidDocScraper.GetDocletType (src)) {

@jonpryor jonpryor Oct 27, 2017

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

It's good that we updated class-parse so that it doesn't always set DocletType, but...do we really want to prefer it?

I'm not convinced that we do.

default: return new DroidDoc2Scraper (src);
case JavaDocletType.DroidDoc: return new DroidDocScraper (src);
case JavaDocletType.Java6: return new JavaDocScraper (src);
Expand Down
39 changes: 39 additions & 0 deletions src/Xamarin.Android.Tools.Bytecode/JavaDocumentScraper.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -290,6 +290,45 @@ public static void LoadXml (String filename)
Log.Error ("Annotations parser error: " + ex);
}
}

public static JavaDocletType GetDocletType (string path)
{
var kind = JavaDocletType.DroidDoc;
char[] buf = new char[500];

string packagesHtml = Path.Combine (path, "packages.html");
if (File.Exists (packagesHtml) && File.ReadAllText (packagesHtml).Contains ("<body class=\"gc-documentation develop reference api "))
kind = JavaDocletType.DroidDoc2;

string indexHtml = Path.Combine (path, "index.html");
if (File.Exists (indexHtml))
{

@jonpryor jonpryor Oct 27, 2017

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

You have some curious formatting settings applied. You have space before ( (yay), but { is on a new line (?).

That's...unexpectedly bizarre.

Please place the { on the same line as the if. :-)

using (var reader = File.OpenText (indexHtml))
reader.ReadBlock (buf, 0, buf.Length);
string rawHTML = new string (buf);
if (rawHTML.Contains ("Generated by javadoc (build 1.6"))
kind = JavaDocletType.Java6;
else if (rawHTML.Contains ("Generated by javadoc (version 1.7"))
kind = JavaDocletType.Java7;
else if (rawHTML.Contains ("Generated by javadoc (1.8"))
kind = JavaDocletType.Java8;
}

// Check to see if it's an api.xml formatted doc
if (File.Exists (path))
{
string rawXML = null;
using (var reader = File.OpenText (path))
{
int len = reader.ReadBlock (buf, 0, buf.Length);
rawXML = new string (buf, 0, len);
}
if (rawXML.Contains ("<api>") && rawXML.Contains ("<package"))
kind = JavaDocletType._ApiXml;
}

return kind;
}
}

public interface IAndroidDocScraper
Expand Down
11 changes: 11 additions & 0 deletions src/Xamarin.Android.Tools.Bytecode/Tests/ClassFileFixture.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,17 @@ protected static string LoadString (string resource)
return r.ReadToEnd ();
}

protected static string LoadToTempFile (string resource)
{
var tempFilePath = Path.GetTempFileName ();

using (var w = File.Create (tempFilePath))
using (var s = Assembly.GetExecutingAssembly ().GetManifestResourceStream (resource))
s.CopyTo (w);

return tempFilePath;
}

protected static void AssertXmlDeclaration (string classResource, string xmlResource, string documentationPath = null, JavaDocletType? javaDocletType = null)
{
var classPathBuilder = new ClassPath () {
Expand Down
58 changes: 41 additions & 17 deletions src/Xamarin.Android.Tools.Bytecode/Tests/ParameterFixupTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
using System;
using System.IO;
using NUnit.Framework;
using Xamarin.Android.Tools.Bytecode;

namespace Xamarin.Android.Tools.BytecodeTests
{
Expand Down Expand Up @@ -30,27 +31,17 @@ public void XmlDeclaration_FixedUpFromDocumentation()
}

[Test]
public void XmlDeclaration_FixedUpFromApiXmlDocumentation()
public void XmlDeclaration_FixedUpFromApiXmlDocumentation ()
{
string tempFile = null;

try
{
tempFile = Path.GetTempFileName();
File.WriteAllText(tempFile, LoadString("ParameterFixupApiXmlDocs.xml"));

AssertXmlDeclaration("Collection.class", "ParameterFixupFromDocs.xml", tempFile, Bytecode.JavaDocletType._ApiXml);
}
catch (Exception ex)
{
try
{
if (File.Exists(tempFile))
File.Delete(tempFile);
}
catch { }
try {
tempFile = LoadToTempFile ("ParameterFixupApiXmlDocs.xml");

Assert.Fail("An unexpected exception was thrown : {0}", ex);
AssertXmlDeclaration ("Collection.class", "ParameterFixupFromDocs.xml", tempFile);
} finally {
if (File.Exists (tempFile))
File.Delete (tempFile);
}
}

Expand All @@ -63,6 +54,39 @@ public void XmlDeclaration_DoesNotThrowAnExceptionIfDocumentationNotFound ()
Assert.Fail ("An unexpected exception was thrown : {0}", ex);
}
}

[Test]
public void DocletType_ShouldDetectApiXml ()
{
string tempFile = null;

try {
tempFile = LoadToTempFile ("ParameterFixupApiXmlDocs.xml");

Assert.AreEqual (JavaDocletType._ApiXml, AndroidDocScraper.GetDocletType (tempFile));
} finally {
if (File.Exists (tempFile))
File.Delete (tempFile);
}
}

[Test]
public void DocletType_ShouldDetectDroidDocs ()
{
var androidSdkPath = Environment.GetEnvironmentVariable ("ANDROID_SDK_PATH");
if (string.IsNullOrEmpty (androidSdkPath)) {
Assert.Ignore("The `ANDROID_SDK_PATH` environment variable isn't set; " +
"cannot test importing parameter names from HTML. Skipping...");
return;
}

var droidDocsPath = Path.Combine (androidSdkPath, "docs", "reference");

if (!Directory.Exists (droidDocsPath))
Assert.Fail("The Android SDK Documentation path `{0}` was not found.", droidDocsPath);

Assert.AreEqual(JavaDocletType.DroidDoc2, AndroidDocScraper.GetDocletType(droidDocsPath));
}
}
}