Configure TF

Create a user with the rights to launch job execution remotely

On Squash TF Execution Server you have to create a user (ex : tmLauncher) able to launch remotely the execution of the job(s) who handle the tests.

  • Login with a user having admin rights on your Squash TF Execution Server

  • Go to Manage Jenkins \ Manage Users

  • Click on Create User in the left menu

  • Fill the field :

    ../_images/tfCreateUser.png
  • Click on the button Create User

Note

This user credentials will be needed when you will define this automation server in Squash TM. Keep them near you.

Warning

By default Logged-in users can do anything strategy is selected for access control in Jenkins. You may want to use another access control strategy. To do so, go to Manage Jenkins \ Configure Global Security section Access Control. In such a case, don’t forget to give the rights to launch job execution remotely to the user we’ve just created.

Configuring Squash TM callback

When Squash TM asks the execution of automated tests to Squash TF Execution Server, the Squash TM request also contains it’s callback URL.

Squash TF Execution Server use this callback URL in two ways :

  • As base url to send to Squash TM feedback about the progress of the execution
  • To retrieve the right credentials to use to send feedback to Squash TM

On Squash TF Server side, the association between the callback URL and the credentials is done in a properties file. To modify this file:

  • In your jenkins interface go to Manage jenkins / Managed files
  • Edit the file taLinkConf.properties
../_images/edit_conf.properties.png
  • In this file, you should define an endpoint for each TM Server using this Squash TF Execution Server. For each endpoint you have to define the Squash TM callback URL and the credentials of a Squash TM User authorized to send feedback to Squash TM. For example a TM Server which callback URL is : http://myServer:8080/squash and the credentials are tmFeedbackLogin / tmFeedbackPassword then you should define the three properties below:

    endpoint.1=http://myServer:8080/squash
    endpoint.1.login=tmFeedbackLogin
    endpoint.1.password=tmFeedbackPassword
    

Note

The credentials associated to the callback URL are those of a user define in Squash TM. This Squash TM user should belong to the Test Automation Server group in order to have right to send feedback to Squash TM. See the TM configuration page for more details.

Warning

The callbackURL define in Squash TM configuration file should perfectly match the one define in your endpoint. If you wonder why, the answer is Squash TM put the callbackURL from its configuration file in the execution request it sends to Squash TF Execution Server. And this last one, use it to retrieve the good endpoint. So if they not match, no endpoint is found.

Configuring JENKINS_URL

Squash TF provides the URL of the execution report to Squash TM. To do so, the JENKINS_URL variable should be set as follows:

  • Go to “Manage Jenkins / Configure system”
  • In the “Jenkins location” section, set the correct value for the “Jenkins URL” property
  • Click on “Save” or “Apply”

Note

When you first start Jenkins, even if the “JENKINS_URL” field contains the right value, you have to click on “Save” or “Apply”. Otherwise the JENKINS_URL property won’t be set.