Versions Compared

Old Version 2

changes.mady.by.user Pierre Lasou

Saved on

compared with

New Version 3

changes.mady.by.user Pierre Lasou

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Starting Testing

...

PRs

How to find PR for testing

If you are less technical, or just getting started, we recommend beginning your testing (or code review) with Pull Requests that contain the "1 Approval" label.  These are smaller Pull Requests that need a very quick test or review (usually a small bug fix or improvement).

...

We recommend testing whichever pull requests are of interest to you.  You may find one relating to a bug that you'd also seen, or something that sounds easy for you to test, etc.  The choice is up to you.

How to select a PR to test

Things important to consider before selecting a issue to test: 

...

Understanding what to test

For testing:

...

  • Look if issue a Github Issue is linked , give to the PR, it usualy gives more information of on the feature to test.
  • If test instructions are unclear, put a comment asking for instructions
  • Tester do not need to be assign a PR to test it.


If the PR needs a specific configuration, it can be change: recommandation is to use a local.cfg containing the config value for the test. i.e, if the feature change in the PR use emails, it is necessary to configure SMTP using you SMTP reference.

Testing the DSpace Pull Request (PR)



Testing a Frontend PRTesting a Backend PR
Move to relevant directorydspace-angular DSpace
Checkout the PR code

Find the number of the Pull Request

gh pr checkout 1234 (where 1234 is the PR number)

Find the number of the Pull Request

gh pr checkout 1234 (where 1234 is the PR number)

Rebuild based on that PR's code

docker-compose -p d7 -f docker/docker-compose.yml build

Note: Build duration (Angular): 3-4 minutes with a good bandwith/connexion

This will create a new Docker Image including the PR code.

docker-compose -f docker-compose.yml -f docker-compose-cli.yml build

Note: Build duration (backend): environ 5-10 minutes with a good bandwith/connexion

This will create a new Docker Image including the PR code.

Start services needed

Frontend can be start using command line or Docker Software UI.

Commandline: 

Ensure you are positionned in dSpace-angular folder (cd command to dspace-angular)

Run following command: 
docker-compose -p d7 -f docker/docker-compose.yml up -d

This command will start the container using the new Docker image created. 

Backend can be start using command line or Docker Software UI.

Commandline: 

Ensure you are positionned in DSpace folder (cd to DSpace if not)

Run following command: 
docker-compose -p d7 up -d

This command will start the container using the new Docker image created. 

...

Once you are ready to check the PRs: open Dev tool of you prefered browser

If an error occurs, check the log, either backend or frontend log can be accessed using Docker by clicking on the containers Name (i.e: dspace-angular or dspacedb, etc.)

When trying to checkout a PR, a conflict error can occur, mentionning to commit your change before checking our the PR.

Ex:

error: Your local changes to the following files would be overwritten by checkout:
        dspace/config/item-submission.xml
Please commit your changes or stash them before you switch branches.

To solve this issue, it is possible to proceed as follow: 

...

git checkout main

...

)

Reporting test results

The PR's description should describe how to test it and what you should see.

...