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.

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

Migrate "Transformation analyzer" module to V4 report #243

Closed
6 tasks
ChristopherJennings opened this issue Apr 25, 2019 · 2 comments
Closed
6 tasks

Migrate "Transformation analyzer" module to V4 report #243

ChristopherJennings opened this issue Apr 25, 2019 · 2 comments
Assignees
Labels
groomed Well-defined and ready to be worked on help wanted This is an opportunity for anyone to contribute report migration

Comments

@ChristopherJennings
Copy link
Contributor

ChristopherJennings commented Apr 25, 2019

Overview

We should migrate the Transformation analyzer module to the new V4 report format.

Definition of done

  • Code and Scripts are ported to KenticoInspector.Reports project in a dedicated folder for the report.
  • Scripts are referenced via constants in a static class.
  • Scripts are refactored to return simple results that are mappable to simple classes.
  • Report logic is covered by unit test for a clean result
  • Report logic is covered by unit tests for all known dirty results
  • Useful, non-specific logic is abstracted to services or helpers.

Note: The Class/Table Validation report (and it's tests) is a good, simple example of the main concepts.

Additional Details

  • New name: Transformation Security Analysis
  • Tags: Portal Engine, Security, Transformations
@ChristopherJennings ChristopherJennings added help wanted This is an opportunity for anyone to contribute groomed Well-defined and ready to be worked on report migration labels Apr 25, 2019
@ChristopherJennings ChristopherJennings added this to the 4.NEXT milestone Apr 25, 2019
@ChristopherJennings ChristopherJennings added this to Priority in Prioritization via automation Apr 25, 2019
@ChristopherJennings ChristopherJennings added this to To do in Kentico Inspector V4 via automation Apr 25, 2019
@ChristopherJennings ChristopherJennings moved this from Priority to Medium in Prioritization Apr 25, 2019
@yuriys-kentico
Copy link
Contributor

I claim ownership!

@yuriys-kentico
Copy link
Contributor

I am unsure how to format the results. I have three ideas:

List of tables by issue type
Each issue will have a separate table, and each row will be the snippet, reason, property details, web part, and template.

Drawback: Repetition of web part and template details.

One table by transformation
Each transformation is a row with the snippets, reason and template usage.

Drawback: Repetition of web part and template details.

One table by template
Each template is a "row" with a nested structure for web parts, their properties, and issues under each transformation. It would look like this:

NestedTable

Drawback: Not sure how to display that in a plain table. Each cell has text wrapping, so it is impossible to maintain cell divisions. Issue reasons could be duplicated in the last column.

I like the last one because it allows a user to see where in a site an issue appears. This context could help locate the transformation on the page and also affect its severity.

@ChristopherJennings ChristopherJennings moved this from In progress to Review in progress in Kentico Inspector V4 Jul 12, 2019
Kentico Inspector V4 automation moved this from Review in progress to Done Aug 1, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
groomed Well-defined and ready to be worked on help wanted This is an opportunity for anyone to contribute report migration
Development

No branches or pull requests

2 participants