You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@hop.apache.org by "bamaer (via GitHub)" <gi...@apache.org> on 2025/11/10 10:45:06 UTC

[I] [Bug]: multiple issues with `hop doc` (hop)

bamaer opened a new issue, #5981:
URL: https://github.com/apache/hop/issues/5981

   ### Apache Hop version?
   
   2.16.0-SNAPSHOT
   
   ### Java version?
   
   17
   
   ### Operating system
   
   Windows
   
   ### What happened?
   
   The new `hop doc` tool has multiple issues, making it close to impossible to use. The ticket mentions Windows as the operating system, but the issue is the same on Windows, MacOS and Linux.  
   
   running the `hop doc` command as specified in the docs throws an errror: 
   command: `./hop doc -n samples --include-notes --include-parameters --include-metadata`
   output: `2025/11/10 11:35:28 - HopDoc - ERROR: No project home folder specified: giving up.`
   
   updating the command to a more extended version that doesn't throw this error throws lots of `NullPointerExceptions`: 
   command: 
   `./hop doc -n hop-tests -s <PATH_TO_PROJECT > -t <PATH_TO_OUTPUT_FOLDER>`
   
   output (throws the same error for all processed workflows/pipelines): 
   ```
   ...
   2025/11/10 11:41:40 - General - ERROR: Error calling extension point(s) for the pipeline painter transform
   2025/11/10 11:41:40 - General - ERROR: java.lang.NullPointerException: Cannot invoke "org.apache.hop.ui.hopgui.perspective.HopPerspectiveManager.findPerspective(java.lang.Class)" because the return value of "org.apache.hop.ui.hopgui.HopGui.getPerspectiveManager()" is null
   2025/11/10 11:41:40 - General -         at org.apache.hop.ui.hopgui.HopGui.getDataOrchestrationPerspective(HopGui.java:1597)
   2025/11/10 11:41:40 - General -         at org.apache.hop.testing.gui.TestingGuiPlugin.getStateMap(TestingGuiPlugin.java:1180)
   2025/11/10 11:41:40 - General -         at org.apache.hop.testing.gui.TestingGuiPlugin.getCurrentUnitTest(TestingGuiPlugin.java:1195)
   2025/11/10 11:41:40 - General -         at org.apache.hop.testing.xp.DrawGoldenDataSetOnTransformExtensionPoint.callExtensionPoint(DrawGoldenDataSetOnTransformExtensionPoint.java:54)
   2025/11/10 11:41:40 - General -         at org.apache.hop.testing.xp.DrawGoldenDataSetOnTransformExtensionPoint.callExtensionPoint(DrawGoldenDataSetOnTransformExtensionPoint.java:41)
   2025/11/10 11:41:40 - General -         at org.apache.hop.core.extension.ExtensionPointMap.callExtensionPoint(ExtensionPointMap.java:149)
   2025/11/10 11:41:40 - General -         at org.apache.hop.core.extension.ExtensionPointHandler.callExtensionPoint(ExtensionPointHandler.java:41)
   2025/11/10 11:41:40 - General -         at org.apache.hop.pipeline.PipelinePainter.drawTransform(PipelinePainter.java:925)
   2025/11/10 11:41:40 - General -         at org.apache.hop.pipeline.PipelinePainter.drawPipeline(PipelinePainter.java:295)
   2025/11/10 11:41:40 - General -         at org.apache.hop.pipeline.PipelinePainter.drawPipelineImage(PipelinePainter.java:204)
   2025/11/10 11:41:40 - General -         at org.apache.hop.pipeline.PipelineSvgPainter.generatePipelineSvg(PipelineSvgPainter.java:82)
   2025/11/10 11:41:40 - General -         at org.apache.hop.documentation.PipelineDocDelegate.buildPipelineDocumentation(PipelineDocDelegate.java:81)
   2025/11/10 11:41:40 - General -         at org.apache.hop.documentation.DocBuilder.processHopFolder(DocBuilder.java:401)
   2025/11/10 11:41:40 - General -         at org.apache.hop.documentation.DocBuilder.processDocumentationFolder(DocBuilder.java:333)
   2025/11/10 11:41:40 - General -         at org.apache.hop.documentation.DocBuilder.buildDocumentation(DocBuilder.java:210)
   2025/11/10 11:41:40 - General -         at org.apache.hop.documentation.DocBuilder.run(DocBuilder.java:185)
   2025/11/10 11:41:40 - General -         at picocli.CommandLine.executeUserObject(CommandLine.java:2045)
   2025/11/10 11:41:40 - General -         at picocli.CommandLine.access$1500(CommandLine.java:148)
   2025/11/10 11:41:40 - General -         at picocli.CommandLine$RunLast.executeUserObjectOfLastSubcommandWithSameParent(CommandLine.java:2469)
   2025/11/10 11:41:40 - General -         at picocli.CommandLine$RunLast.handle(CommandLine.java:2461)
   2025/11/10 11:41:40 - General -         at picocli.CommandLine$RunLast.handle(CommandLine.java:2423)
   2025/11/10 11:41:40 - General -         at picocli.CommandLine$AbstractParseResultHandler.execute(CommandLine.java:2277)
   2025/11/10 11:41:40 - General -         at picocli.CommandLine$RunLast.execute(CommandLine.java:2425)
   2025/11/10 11:41:40 - General -         at picocli.CommandLine.execute(CommandLine.java:2174)
   2025/11/10 11:41:40 - General -         at org.apache.hop.hop.Hop.main(Hop.java:129)
   2025/11/10 11:41:40 - General - ERROR: Error calling extension point(s) for the pipeline painter transform
   ...
   ```
   
   
   ### Issue Priority
   
   Priority: 2
   
   ### Issue Component
   
   Component: CLI


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@hop.apache.org.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [I] [Bug]: multiple issues with `hop doc` (hop)

Posted by "bamaer (via GitHub)" <gi...@apache.org>.
bamaer commented on issue #5981:
URL: https://github.com/apache/hop/issues/5981#issuecomment-3638452950

   Looking forward to your example command to generate non-empty docs for the samples project. 


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@hop.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [I] [Bug]: multiple issues with `hop doc` (hop)

Posted by "bamaer (via GitHub)" <gi...@apache.org>.
bamaer commented on issue #5981:
URL: https://github.com/apache/hop/issues/5981#issuecomment-3638610408

   I know that page exists, the point of "multiple issues" is that it does not work. 
   
   The generated output is close to empty, for example:
   
   ```
   ---
   title: Pipeline add-constants
   ---
   
   * Filename : add-constants.hpl
   * Last modified: 2023-02-05 11:09:40
   
   ## Image
   
   ![*Image of pipeline : add-constants*](../assets/images/add-constants-pipeline4966d6c1-09ec-46fc-92bc-ec386d2f1781.svg "Pipeline add-constants")
   ``` 
   
   I initially tested this on Windows, but same/similar issues on Linux and MacOS. 
   This is a copy/paste from the command on the documentation page, only changed "demo" to "samples". The `Error calling extension point(s) for the pipeline painter transform` error obviously is repeated for every hpl/hwf file. 
   
   `./hop doc -j samples -t /tmp/hop/docs --include-notes --include-parameters --include-metadata`
   
   ```
   ./hop doc -j samples -t /tmp/hop/docs --include-notes --include-parameters --include-metadata
   2025/12/10 19:57:03 - HopDoc - Enabling project 'samples'
   2025/12/10 19:57:03 - HopDoc - Documenting folder: /Users/bart/git-hop/hop/assemblies/client/target/hop/config/projects/samples for project samples
   2025/12/10 19:57:03 - HopDoc - Processing documentation folder .
   2025/12/10 19:57:03 - HopDoc - Processing pipelines and workflows in folder .
   2025/12/10 19:57:03 - HopDoc - Processing documentation folder neo4j
   2025/12/10 19:57:03 - HopDoc - Processing pipelines and workflows in folder neo4j
   2025/12/10 19:57:03 - HopDoc -  - documenting pipeline: neo4j-cypher-complex-returns.hpl to /tmp/hop/docs/neo4j/neo4j-cypher-complex-returns-pipeline.md
   2025/12/10 19:57:04 - General - ERROR: Error calling extension point(s) for the pipeline painter transform
   2025/12/10 19:57:04 - General - ERROR: java.lang.NullPointerException: Cannot invoke "org.apache.hop.ui.hopgui.perspective.HopPerspectiveManager.findPerspective(java.lang.Class)" because the return value of "org.apache.hop.ui.hopgui.HopGui.getPerspectiveManager()" is null
   2025/12/10 19:57:04 - General -         at org.apache.hop.ui.hopgui.HopGui.getExplorerPerspective(HopGui.java:1663)
   2025/12/10 19:57:04 - General -         at org.apache.hop.testing.gui.TestingGuiPlugin.getStateMap(TestingGuiPlugin.java:1180)
   2025/12/10 19:57:04 - General -         at org.apache.hop.testing.gui.TestingGuiPlugin.getCurrentUnitTest(TestingGuiPlugin.java:1195)
   2025/12/10 19:57:04 - General -         at org.apache.hop.testing.xp.DrawGoldenDataSetOnTransformExtensionPoint.callExtensionPoint(DrawGoldenDataSetOnTransformExtensionPoint.java:54)
   2025/12/10 19:57:04 - General -         at org.apache.hop.testing.xp.DrawGoldenDataSetOnTransformExtensionPoint.callExtensionPoint(DrawGoldenDataSetOnTransformExtensionPoint.java:41)
   2025/12/10 19:57:04 - General -         at org.apache.hop.core.extension.ExtensionPointMap.callExtensionPoint(ExtensionPointMap.java:149)
   2025/12/10 19:57:04 - General -         at org.apache.hop.core.extension.ExtensionPointHandler.callExtensionPoint(ExtensionPointHandler.java:41)
   2025/12/10 19:57:04 - General -         at org.apache.hop.pipeline.PipelinePainter.drawTransform(PipelinePainter.java:925)
   2025/12/10 19:57:04 - General -         at org.apache.hop.pipeline.PipelinePainter.drawPipeline(PipelinePainter.java:295)
   2025/12/10 19:57:04 - General -         at org.apache.hop.pipeline.PipelinePainter.drawPipelineImage(PipelinePainter.java:204)
   2025/12/10 19:57:04 - General -         at org.apache.hop.pipeline.PipelineSvgPainter.generatePipelineSvg(PipelineSvgPainter.java:82)
   2025/12/10 19:57:04 - General -         at org.apache.hop.documentation.PipelineDocDelegate.buildPipelineDocumentation(PipelineDocDelegate.java:81)
   2025/12/10 19:57:04 - General -         at org.apache.hop.documentation.DocBuilder.processHopFolder(DocBuilder.java:401)
   2025/12/10 19:57:04 - General -         at org.apache.hop.documentation.DocBuilder.processDocumentationFolder(DocBuilder.java:333)
   2025/12/10 19:57:04 - General -         at org.apache.hop.documentation.DocBuilder.buildDocumentation(DocBuilder.java:210)
   2025/12/10 19:57:04 - General -         at org.apache.hop.documentation.DocBuilder.run(DocBuilder.java:185)
   2025/12/10 19:57:04 - General -         at picocli.CommandLine.executeUserObject(CommandLine.java:2045)
   2025/12/10 19:57:04 - General -         at picocli.CommandLine.access$1500(CommandLine.java:148)
   2025/12/10 19:57:04 - General -         at picocli.CommandLine$RunLast.executeUserObjectOfLastSubcommandWithSameParent(CommandLine.java:2469)
   2025/12/10 19:57:04 - General -         at picocli.CommandLine$RunLast.handle(CommandLine.java:2461)
   2025/12/10 19:57:04 - General -         at picocli.CommandLine$RunLast.handle(CommandLine.java:2423)
   2025/12/10 19:57:04 - General -         at picocli.CommandLine$AbstractParseResultHandler.execute(CommandLine.java:2277)
   2025/12/10 19:57:04 - General -         at picocli.CommandLine$RunLast.execute(CommandLine.java:2425)
   2025/12/10 19:57:04 - General -         at picocli.CommandLine.execute(CommandLine.java:2174)
   2025/12/10 19:57:04 - General -         at org.apache.hop.hop.Hop.main(Hop.java:129)
   2025/12/10 19:57:04 - General - ERROR: Error calling extension point(s) for the pipeline painter transform
   ```


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@hop.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [I] [Bug]: multiple issues with `hop doc` (hop)

Posted by "hansva (via GitHub)" <gi...@apache.org>.
hansva closed issue #5981: [Bug]: multiple issues with `hop doc`
URL: https://github.com/apache/hop/issues/5981


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@hop.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [I] [Bug]: multiple issues with `hop doc` (hop)

Posted by "mattcasters (via GitHub)" <gi...@apache.org>.
mattcasters commented on issue #5981:
URL: https://github.com/apache/hop/issues/5981#issuecomment-3640742046

   The system is supposed to detect GUI land with
   
   ```
       if (!"GUI".equalsIgnoreCase(Const.getHopPlatformRuntime())) {
         return null;
       }
   ```
   
   It appears this is no longer working so we'd have to check all possible locations where this runtime constant is used.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@hop.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [I] [Bug]: multiple issues with `hop doc` (hop)

Posted by "mattcasters (via GitHub)" <gi...@apache.org>.
mattcasters commented on issue #5981:
URL: https://github.com/apache/hop/issues/5981#issuecomment-3627682774

   What part of `No project home folder specified` was specifically unclear @bamaer ?
   Just specify the name of the project to use with the `-j` option, like in all other commands.
   The confusion probably comes from the  `-n` option, which can be used to specify an alternative name in the generated documentation.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@hop.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [I] [Bug]: multiple issues with `hop doc` (hop)

Posted by "mattcasters (via GitHub)" <gi...@apache.org>.
mattcasters commented on issue #5981:
URL: https://github.com/apache/hop/issues/5981#issuecomment-3638907656

   Of-course we could go nuts and host the integration test projects documentation somewhere on the Hop website.  That might allow us to see immediately if things break.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@hop.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [I] [Bug]: multiple issues with `hop doc` (hop)

Posted by "bamaer (via GitHub)" <gi...@apache.org>.
bamaer commented on issue #5981:
URL: https://github.com/apache/hop/issues/5981#issuecomment-3638746995

   Definitely from well before the 2.16.0 release, so not very recent. The reproduction path is the command in the docs and the comment above. 
   Happy to look into it too. I didn't have the time when I reported this, but things should start to calm down a bit in the next couple of weeks. 


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@hop.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [I] [Bug]: multiple issues with `hop doc` (hop)

Posted by "mattcasters (via GitHub)" <gi...@apache.org>.
mattcasters commented on issue #5981:
URL: https://github.com/apache/hop/issues/5981#issuecomment-3638487677

   https://hop.apache.org//manual/latest/hop-doc/index.html#_example
   
   So yeah I do think that we need to change the options a bit, make them a bit more clearer.  Suggestions are welcome of-course.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@hop.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [I] [Bug]: multiple issues with `hop doc` (hop)

Posted by "mattcasters (via GitHub)" <gi...@apache.org>.
mattcasters commented on issue #5981:
URL: https://github.com/apache/hop/issues/5981#issuecomment-3638646813

   Thanks. I'll figure out how to reproduce it.  It looks like it's caused by a change to the unit testing code.  Probably something recent.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@hop.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [I] [Bug]: multiple issues with `hop doc` (hop)

Posted by "mattcasters (via GitHub)" <gi...@apache.org>.
mattcasters commented on issue #5981:
URL: https://github.com/apache/hop/issues/5981#issuecomment-3638901987

   As always, thanks for the help.  The fix itself is probably going to be a one-liner to prevent the unit test code from diving into HopGui land.  The bulk of the work is going to be the creation of an integration test to prevent us from being surprised with things breaking ever again.  The main issue there is that for large projects I don't want one error to stop doc generation.  So this means some log analysis, counting of produced `.md` files, something like that. 


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@hop.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org