Skip to content

First steps

Sven Dolderer edited this page Mar 1, 2022 · 10 revisions

Documentation

GitHub pages

Please look at https://mercedes-benz.github.io/sechub/ here you find links to latest SecHub documentation readable online.

Videos

How to setup SecHub from scratch and bring an integration test server instance alive

0

It shows how to setup SecHub from scratch and bring an integration test server instance alive with mocked product adapters.

This is a nice way to test SecHub, write integration tests, etc., or just to play around …​

Generate documentation

Just call

./gradlew documentation

from root folder of cloned repository. After gradle task has finished, you will find documents (techdoc, architecture, REST APi, …​) in PDF and HTML format at /sechub-doc/build/asciidoc.

Development setup

Please refer to
Online documentation or direct Asciidoc file

Test with mocked environment

SecHub is able to use a mocked security infrastructure environment - so much easier to develop and test.

Start integration test server with mocked products

In integration test server mode the server is able to handle some things in a convenient style for developers: - fixed password - easy to fill with test data - remembers emails - …​ more

⚠️
Never use integration test server in production!!!!!

Simplest way to start an integration test server with mocked product executors, is to call

./gradlew startIntegrationTestServer

from root folder.

💡
Of course you can do this from your IDE as well, or even with real products. Please refer to online technical documentation for more details.

Developer Admin UI

Launch from IDE

ℹ️
This is a very spartanic admin UI, only for developers - but it works.

Launch com.mercedesbenz.sechub.developertools.admin.ui.DeveloperAdministrationUI with

-Dsechub.developertools.admin.integrationtestserver=true
-Dsechub.developertools.admin.server=localhost
-Dsechub.developertools.admin.serverport=8443
-Dsechub.developertools.admin.userid=int-test_superadmin
-Dsechub.developertools.admin.apitoken=int-test_superadmin-pwd

Create automated test data (scenario3)

Just execute Create TestData action from main menu as shown in next picture:

SecHub developer admin UI - create test scenario 3 data

After this action has been executed, you will have user scenario3_user1 assigned to scenario3_project

Next steps

You can now try out further UI action or test sechub by client or REST API. As server you have to use localhost and port 8443 thats all.