Read external resources locally when generating html report #404

eyedol · 2024-06-10T17:55:18Z

Fixes #295

Changes:

Use webjars to add the materialize.min.css, materialize.min.js, material-icons resources to the generated html report.
Move the reports html from a string constant to a index.html file for easier editing
Reference all the external resources as a relative local path in index.html
Generate the html report based on the local index.html file

eyedol · 2024-06-10T17:56:27Z

...build/roborazzi-gradle-plugin/src/main/java/io/github/takahirom/roborazzi/RoborazziPlugin.kt

 oldValue = "REPORT_TEMPLATE_BODY",
 newValue = roborazziResults.toHtml(reportFile.parentFile.absolutePath)
- )
+ ) ?: ""


Perhaps error in this case?

takahirom · 2024-06-11T01:11:42Z

Thanks! The code looks good. However, I'm concerned about the LICENSE. I'm not sure if it is appropriate to include these files. I'm really sorry for noticing this late. 🙇

eyedol · 2024-06-11T18:38:28Z

Thanks! The code looks good. However, I'm concerned about the LICENSE. I'm not sure if it is appropriate to include these files. I'm really sorry for noticing this late. 🙇

That's a good concern to have. Checking the license for materialize.min.css, materialize.min.js it's the MIT license so we should be good. I'm no lawyer though, if you are able to verify with a lawyer it would be great. But personally I think it's fine as we're respecting everything stated in the MIT license.

We have made these icons available for you to incorporate them into your products under the Apache License Version 2.0. Feel free to remix and re-share these icons and documentation in your products. We'd love attribution in your app's about screen, but it's not required.

For the material icons it's Apache 2 license 1. I believe we're good with this too.

takahirom · 2024-06-12T00:23:13Z

I agree with you. However, we might need to include both the Apache 2.0 and MIT licenses in our documentation. This could make it look a bit strange to users.

eyedol · 2024-06-12T16:58:24Z

Oh I see. Is this to credit them? The license info are clear in the header of the minified files in case you're not aware.

takahirom · 2024-06-13T01:39:00Z

Well, it is tough, but if we separate the repository into something like html-report-resources and make sure the license for Materialize is MIT and for the font is Apache 2.0, it might work. Maven includes license information, so this could be a viable solution.

eyedol · 2024-06-13T20:03:47Z

You suggesting we create an entire separate repo to host the, the css and js files or create a new folder(to host the external files) in the same repo as this?

takahirom · 2024-06-15T07:21:59Z

I found something 👀 Could we use this..?
https://mvnrepository.com/artifact/org.webjars/materializecss/1.0.0

eyedol · 2024-06-15T17:52:32Z

That's gold. That should work. I'll look into it then. Thanks

Locally add all JS, CSS and fonts locally to the gradle plugin

takahirom · 2024-06-17T01:05:51Z

include-build/roborazzi-gradle-plugin/src/main/java/io/github/takahirom/roborazzi/WebAssets.kt

+import org.webjars.WebJarVersionLocator
+import java.io.File
+
+class WebAssets private constructor(private val webJarVersionLocator: WebJarVersionLocator) {


Looks great👍

Thanks. The CSS from the webjar packing seems a little old. The styling is a little off from main Looking to see if there is a recently one published with webjar.

I noticed it, but it's a subtle change. So I think it is ok

Yeah, however not all the tabs shows. That I think needs to be fixed.

Resolved it with 9864d9d. All the tabs shows now though we lost the fixed sized tabs. I believe it should be okay?

We can now scroll through the tabs! Thank you!

takahirom

Looks great! Thank you for your patience in fixing this!

takahirom · 2024-06-17T01:08:03Z

...build/roborazzi-gradle-plugin/src/main/java/io/github/takahirom/roborazzi/RoborazziPlugin.kt

@@ -50,6 +52,9 @@ open class RoborazziExtension @Inject constructor(objects: ObjectFactory) {
 @Suppress("unused")
 // From Paparazzi: https://github.com/cashapp/paparazzi/blob/a76702744a7f380480f323ffda124e845f2733aa/paparazzi/paparazzi-gradle-plugin/src/main/java/app/cash/paparazzi/gradle/PaparazziPlugin.kt
 abstract class RoborazziPlugin : Plugin<Project> {
+
+ private val webJarVersionLocator = WebJarVersionLocator()


I believe this can be removed now.

Yes. It can be removed now. Thanks for catching it

takahirom · 2024-06-17T02:09:41Z

...build/roborazzi-gradle-plugin/src/main/java/io/github/takahirom/roborazzi/RoborazziPlugin.kt

@@ -32,6 +32,8 @@ import org.jetbrains.kotlin.gradle.plugin.mpp.KotlinNativeTargetWithTests
 import org.jetbrains.kotlin.gradle.targets.jvm.KotlinJvmTarget
 import org.jetbrains.kotlin.gradle.targets.native.KotlinNativeBinaryTestRun
 import org.jetbrains.kotlin.gradle.targets.native.tasks.KotlinNativeTest
+import org.webjars.WebJarVersionLocator


Suggested change

import org.webjars.WebJarVersionLocator

takahirom · 2024-06-17T02:10:12Z

...build/roborazzi-gradle-plugin/src/main/java/io/github/takahirom/roborazzi/RoborazziPlugin.kt

+
+ private val webJarVersionLocator = WebJarVersionLocator()
+


Suggested change

private val webJarVersionLocator = WebJarVersionLocator()

takahirom · 2024-06-17T02:11:29Z

include-build/roborazzi-gradle-plugin/src/main/java/io/github/takahirom/roborazzi/WebAssets.kt

+import org.webjars.WebJarVersionLocator
+import java.io.File
+
+class WebAssets private constructor(private val webJarVersionLocator: WebJarVersionLocator) {


I noticed it, but it's a subtle change. So I think it is ok

takahirom · 2024-06-18T00:47:40Z

I'll merge this PR. Since I don't want to include the JS files in the repository history, I'll squash and merge.
Thank you for your contribution!

This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [io.github.takahirom.roborazzi](https://togithub.com/takahirom/roborazzi) | plugin | minor | `1.20.0` -> `1.21.0` | | [io.github.takahirom.roborazzi:roborazzi-junit-rule](https://togithub.com/takahirom/roborazzi) | dependencies | minor | `1.20.0` -> `1.21.0` | | [io.github.takahirom.roborazzi:roborazzi-compose](https://togithub.com/takahirom/roborazzi) | dependencies | minor | `1.20.0` -> `1.21.0` | | [io.github.takahirom.roborazzi:roborazzi](https://togithub.com/takahirom/roborazzi) | dependencies | minor | `1.20.0` -> `1.21.0` | --- > [!WARNING] > Some dependencies could not be looked up. Check the Dependency Dashboard for more information. --- ### Release Notes <details> <summary>takahirom/roborazzi (io.github.takahirom.roborazzi)</summary> ### [`v1.21.0`](https://togithub.com/takahirom/roborazzi/releases/tag/1.21.0) [Compare Source](https://togithub.com/takahirom/roborazzi/compare/1.20.0...1.21.0) ##### Android Studio, IntelliJ IDEA Plugin is coming The Roborazzi Plugin has been released after the previous release. Please check it out. The Roborazzi plugin enhances your development workflow by automatically displaying screenshots related to Roborazzi's screenshot tests within IntelliJ IDEA. Easily view and verify visual outputs directly in your IDE, streamlining your testing and development process. https://github.com/takahirom/roborazzi/assets/1386930/bd3e8106-1971-4ec4-b764-3f1831999228 https://plugins.jetbrains.com/plugin/24561-roborazzi ##### Now, test report assets are written in the same directory as the report HTML. We are using Materialize for the HTML report generated in build/reports/roborazzi. This causes a [Content Security Policy (CSP) problem](https://togithub.com/takahirom/roborazzi/issues/295) when using iframes. As a result, we can't view the report correctly in some projects. To resolve this, we now save the assets like CSS and JS in the same directory as the report HTML. Thank you, [@eyedol](https://togithub.com/eyedol), for tackling this difficult problem. Thank you, [@realdadfish](https://togithub.com/realdadfish), for reporting this! ##### Bug fix In the Windows environment, the image path in the report file is not written correctly. I fixed the path separator to resolve this issue. Thank you for reporting this, [@ben-gooding-hub](https://togithub.com/ben-gooding-hub). ##### What's Changed - \[CI] Update actions/checkout digest to [`a5ac7e5`](https://togithub.com/takahirom/roborazzi/commit/a5ac7e5) by [@renovate](https://togithub.com/renovate) in [https://github.com/takahirom/roborazzi/pull/384](https://togithub.com/takahirom/roborazzi/pull/384) - \[CI] Update nick-fields/retry action to v2.9.0 by [@renovate](https://togithub.com/renovate) in [https://github.com/takahirom/roborazzi/pull/357](https://togithub.com/takahirom/roborazzi/pull/357) - \[CI] Update dependency io.ktor:ktor-serialization-kotlinx-xml to v2.3.11 by [@renovate](https://togithub.com/renovate) in [https://github.com/takahirom/roborazzi/pull/360](https://togithub.com/takahirom/roborazzi/pull/360) - \[Sample] Update dependency androidx.appcompat:appcompat to v1.7.0 by [@renovate](https://togithub.com/renovate) in [https://github.com/takahirom/roborazzi/pull/394](https://togithub.com/takahirom/roborazzi/pull/394) - \[Idea Plugin] Add Roborazzi Preview prototype to Idea Plugin by [@takahirom](https://togithub.com/takahirom) in [https://github.com/takahirom/roborazzi/pull/395](https://togithub.com/takahirom/roborazzi/pull/395) - \[Idea Plugin] Add empty Roborazzi idea plugin by [@takahirom](https://togithub.com/takahirom) in [https://github.com/takahirom/roborazzi/pull/367](https://togithub.com/takahirom/roborazzi/pull/367) - \[Docs] Add faq section about out of memory error by [@sanao1006](https://togithub.com/sanao1006) in [https://github.com/takahirom/roborazzi/pull/402](https://togithub.com/takahirom/roborazzi/pull/402) - \[Idea Plugin] Fix the issue where the image is not selected as intended by [@takahirom](https://togithub.com/takahirom) in [https://github.com/takahirom/roborazzi/pull/403](https://togithub.com/takahirom/roborazzi/pull/403) - \[Idea Plugin] Add README section of idea plugin by [@takahirom](https://togithub.com/takahirom) in [https://github.com/takahirom/roborazzi/pull/405](https://togithub.com/takahirom/roborazzi/pull/405) - \[Internal (compileOnly)] Update dependency androidx.compose.ui:ui-test to v1.6.8 by [@renovate](https://togithub.com/renovate) in [https://github.com/takahirom/roborazzi/pull/397](https://togithub.com/takahirom/roborazzi/pull/397) - \[CI] Update actions/checkout digest to [`692973e`](https://togithub.com/takahirom/roborazzi/commit/692973e) by [@renovate](https://togithub.com/renovate) in [https://github.com/takahirom/roborazzi/pull/406](https://togithub.com/takahirom/roborazzi/pull/406) - \[Docs] Add robolectric.pixelCopyRenderMode to README by [@takahirom](https://togithub.com/takahirom) in [https://github.com/takahirom/roborazzi/pull/409](https://togithub.com/takahirom/roborazzi/pull/409) - \[Docs] Remove unneeded " in README by [@takahirom](https://togithub.com/takahirom) in [https://github.com/takahirom/roborazzi/pull/410](https://togithub.com/takahirom/roborazzi/pull/410) - \[Feature] Read external resources locally when generating html report by [@eyedol](https://togithub.com/eyedol) in [https://github.com/takahirom/roborazzi/pull/404](https://togithub.com/takahirom/roborazzi/pull/404) - \[CI] Update dependency gradle to v8.8 by [@renovate](https://togithub.com/renovate) in [https://github.com/takahirom/roborazzi/pull/354](https://togithub.com/takahirom/roborazzi/pull/354) - \[Bug fix] Fix windows report relative path by [@takahirom](https://togithub.com/takahirom) in [https://github.com/takahirom/roborazzi/pull/419](https://togithub.com/takahirom/roborazzi/pull/419) **Full Changelog**: takahirom/roborazzi@1.20.0...1.21.0 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Enabled. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about these updates again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://togithub.com/renovatebot/renovate).

eyedol commented Jun 10, 2024

View reviewed changes

eyedol force-pushed the 295-inlineHtmlReportsResources branch from acf060b to 525393d Compare June 11, 2024 18:39

eyedol force-pushed the 295-inlineHtmlReportsResources branch from 525393d to 0ce263e Compare June 14, 2024 23:05

eyedol added 10 commits June 16, 2024 16:21

Read external resources locally when generating html report

f2cf09b

Locally add all JS, CSS and fonts locally to the gradle plugin

Use webjars for web assets

f11dc4b

Move function for writing web asset to its own class

0ffb2d0

Simplify how to locate webjar files

12e0128

Minor clean up

72cf195

Load internal css last

b65cc85

Minor clean up

cf8de79

Remove unneeded local files

2b7b652

Minor clean up

589d969

If index.html file not found throw an error

5d333ee

eyedol force-pushed the 295-inlineHtmlReportsResources branch from 0ce263e to 5d333ee Compare June 17, 2024 00:35

takahirom reviewed Jun 17, 2024

View reviewed changes

takahirom approved these changes Jun 17, 2024

View reviewed changes

eyedol added 4 commits June 16, 2024 19:25

Fix function name

0acb0cb

Remove unused declaration

4252666

Show all tabs available

9864d9d

Make error message more clearer

008fabf

takahirom merged commit ffa6222 into takahirom:main Jun 18, 2024
6 checks passed

eyedol deleted the 295-inlineHtmlReportsResources branch June 18, 2024 16:35

eyedol mentioned this pull request Jun 20, 2024

Add unit test for WebAssets class #412

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Read external resources locally when generating html report #404

Read external resources locally when generating html report #404

eyedol commented Jun 10, 2024 •

edited

Loading

eyedol Jun 10, 2024

takahirom commented Jun 11, 2024

eyedol commented Jun 11, 2024

takahirom commented Jun 12, 2024

eyedol commented Jun 12, 2024

takahirom commented Jun 13, 2024

eyedol commented Jun 13, 2024

takahirom commented Jun 15, 2024

eyedol commented Jun 15, 2024

takahirom Jun 17, 2024 •

edited

Loading

eyedol Jun 17, 2024

takahirom Jun 17, 2024

eyedol Jun 17, 2024

eyedol Jun 17, 2024

takahirom Jun 18, 2024

takahirom left a comment

takahirom Jun 17, 2024

eyedol Jun 17, 2024

takahirom Jun 17, 2024

takahirom Jun 17, 2024

takahirom Jun 17, 2024

takahirom commented Jun 18, 2024

Read external resources locally when generating html report #404

Read external resources locally when generating html report #404

Conversation

eyedol commented Jun 10, 2024 • edited Loading

Choose a reason for hiding this comment

takahirom commented Jun 11, 2024

eyedol commented Jun 11, 2024

takahirom commented Jun 12, 2024

eyedol commented Jun 12, 2024

takahirom commented Jun 13, 2024

eyedol commented Jun 13, 2024

takahirom commented Jun 15, 2024

eyedol commented Jun 15, 2024

takahirom Jun 17, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

takahirom left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

takahirom commented Jun 18, 2024

eyedol commented Jun 10, 2024 •

edited

Loading

takahirom Jun 17, 2024 •

edited

Loading