reportportal/docs

ReportPortal documentation

ReportPortal documentation portal

The documentation built with Docusaurus.

The search is implemented using Algolia DocSearch.

The OpenAPI documentation is generated using PaloAltoNetworks docusaurus-openapi-docs plugin.

Running locally

1. Install the dependencies

npm install

2. Run application in development mode

npm run start

3. For production ready build use the next commands:

npm run gen-all
npm run build

Note: To serve the documentation on base path other than /docs/ follow the next steps:

1. create a file .env in the project root
2. Add DOCS_BASE_URL=/ with your preferred base path.

Deployment

Each changes pushing (direct pushing or via merging a Pull Request) to the:

• develop branch will trigger the deployment to the dev environment to AWS S3 bucket.
• master branch will trigger the deployment to the prod environment to GitHub Pages (https://reportportal.io/docs).

Contribution

If you would like to contribute to the docs, feel free to open your Pull Requests to the default branch.

docs's Issues

re-run functionality: create new launch on no match?

I am trying to incorporate re-run functionality provided here by following this guide to consolidate my executions.

Have a question (perhaps a feature request, maybe) on what happens if there system is not able to find a match with same name (mentioned in handling section)

If system cannot find launch with the same name - system throws error with 404 code.

Should we just create a new launch instead? or is there an alternative way of doing this. Maybe a bool flag to create a new launch if no match is found.

Would appreciate any pointers on solving the below issue

2020-05-04 00:11:44.888 DEBUG 1 --- [nio-8585-exec-8] c.e.t.r.w.c.LaunchAsyncController        : startLaunch (1) - Request
 POST /v2/testtrends/launch
 host: 172.16.5.102:8080
 user-agent: python-requests/2.23.0
 content-length: 206
 accept: */*
 accept-encoding: gzip, deflate
 authorization: bearer dummy-data-token
 content-type: application/json
 x-forwarded-for: A.B.C.D
 x-forwarded-host: 172.16.5.102:8080
 x-forwarded-port: 8080
 x-forwarded-prefix: /api
 x-forwarded-proto: http
 x-forwarded-server: 92e1ed063364
 x-real-ip: A.B.C.D
 -- Body --
 {"startTime":1588551104680,"name":"1.2.3_(Build-3017) Execution","description":"Automated Behave Runner","attributes":[{"key":"build","value":"1.2.3_(Build-3017)","system":false}],"rerun":true}
2020-05-04 00:11:44.901 DEBUG 1 --- [nio-8585-exec-8] c.e.t.r.w.c.LaunchAsyncController        : startLaunch (1) - Response  (13 ms)
 Status - OK (method return)
 -- Body --
 {"id":"7c7240f1-561c-42b3-83fb-a1dc1f37f0e5","number":null}
2020-05-04 00:11:44.910 DEBUG 1 --- [cTaskExecutor-1] c.e.t.r.w.rabbit.AsyncReportingListener  : onMessage - Rabbit message
 requestType: START_LAUNCH
 projectName: testtrends
 __TypeId__: com.epam.ta.reportportal.ws.model.launch.StartLaunchRQ
 username: qauser
 -- Body --
 {"startTime":1588551104680,"name":"1.2.3_(Build-3017) Execution","description":"Automated Behave Runner","attributes":[{"key":"build","value":"1.2.3_(Build-3017)","system":false}],"uuid":"7c7240f1-561c-42b3-83fb-a1dc1f37f0e5","rerun":true}
2020-05-04 00:11:44.956 ERROR 1 --- [cTaskExecutor-1] c.e.t.r.w.rabbit.AsyncReportingListener  : exception : com.epam.ta.reportportal.exception.ReportPortalException, message : Launch '1.2.3_(Build-3017) Execution' not found. Did you use correct Launch ID?,  cause : 
2020-05-04 00:11:44.959  WARN 1 --- [cTaskExecutor-1] s.a.r.l.ConditionalRejectingErrorHandler : Execution of Rabbit message listener failed.

org.springframework.amqp.rabbit.support.ListenerExecutionFailedException: Listener threw exception
	at org.springframework.amqp.rabbit.listener.AbstractMessageListenerContainer.wrapToListenerExecutionFailedExceptionIfNeeded(AbstractMessageListenerContainer.java:1683)

Should I check the response for "number":null and re-initiate the launch request without rerun?

Some details on my versioning...

reportportal/service-api:5.0.0
reportportal/service-analyzer:5.0.0
reportportal/service-index:5.0.5
rabbitmq:3.7.16-management
minio/minio:latest
docker.elastic.co/elasticsearch/elasticsearch-oss:7.3.0
reportportal/service-authorization:5.0.0
traefik:1.7.12
postgres:12-alpine
reportportal/service-ui:5.0.0

Azure SAML callbackURI doesn't support "private" as TLD.

Screenshot attached.

It is expected that you can use any domain name, especially for a private environment

Could you please advice something or make a fix?

Upgrade instruction

Could you please add a detailed information about "How to upgrade from... to...", Just to avoid possible issues which can exist during upgrade (like a losing an existing data).

Documentation page is blank

Hey, when I enter https://reportportal.io/docs
I see a blank page with a search bar.

There is an error in the JS Console:

Uncaught TypeError: Cannot read property 'split' of undefined
    at Object.buildIndex (app.c33480.js:25)
    at Object.addAnchor (app.c33480.js:25)
    at Object.addTagToSection (app.c33480.js:25)
    at app.c33480.js:25
    at Function.i (app.c33480.js:1)
    at Object.convertData (app.c33480.js:25)
    at Object.init (app.c33480.js:25)
    at app.c33480.js:25
    at l (app.c33480.js:24)
    at Object.fireWith [as resolveWith] (app.c33480.js:24)

The page itself returns a 404 error.
There is a skeleton for the page but the content is not there

Invalid static images representation in Safari browser [@Demo]

Link: http://web.demo.reportportal.io/ui/#default_personal/launches/all?page.page=1&page.size=50

Topic "How report tests with nested steps?" doesn't redirect to the page with an answer

Steps:

1. Open Developers guide
2. Try to open How report tests with nested steps? page

Expected result: Topic redirects to the page with the answer how to do this :)
Actual result: Text doesn't have the proper link.

store pass should be together in keytool command

Hi Guys,

In Section TipsAndTricks/HowToResolveIssuesWithJira there is a command for import cer keytool -importcert -noprompt -file foo.crt -alias "JIRA CERT" -keystore cacerts -store pass abc123

"store pass" should be print together as "storepass"

Thanks,
Slava

Incorrect JVM based agents docs structure

Service ml analyzer is unable to delete

Hey,

We are using in our company report-portal with the latest docker-compose file provided
and change to work with mongodb as another instance.

we facing one primary issue with the project:
each time we trying to delete 1 or more reports including tests or classified with the AI the deletion is taking a lot of time sometimes more than 5 min for a single deletion.

in the service-api logs we can see that the ml analyzer is unable to delete

ERROR 1 --- [nio-8080-exec-8] c.e.t.r.c.a.c.AnalyzerServiceClient : Indexing failed. Cannot interact with ML analyzer. Error: {}

we expect that the deletion and investigating operations will take no more than a few seconds

can someone please assist?
@evjlobanova

Data are not storing into S3 bucket mounted directory

I have tried to install report portal application using docker-compose.yml version 23.1.1 file using the command
docker-compose -p reportportal up -d --force-recreate

Created S3 bucket mounted directory in linux server /test-data
I want to store the data into that mounted directory.So tried changing the volumes like below
/test-data: /var/lib/postgresql/data in postgres service
/test-data: /usr/share/elasticsearch/data in elasticsearch service
/test-data: /data in minio
But couldn't able to pointing to /test-data mounting path.
Please provide me any solution on this.

Normally when i create the data are stored in the current directory data/storage path. But i wanted to change in S3 mounted path /test-data

Include markdown mode in documentation

Hi, could we add this into documentation?
I haven't found this option there.

I mean !!!MARKDOWN_MODE!!! in logs to set up different render.

Broken images url issues

A lot of images aren't displayed on site
E.g see pages
http://reportportal.io/docs/A-test-item
http://reportportal.io/docs/Copy-results-from
http://reportportal.io/docs/How-to-add
http://reportportal.io/docs/How-to-resolve