Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated Readme to include more complete instructions on running S1AP tester #38

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

nickvsnetworking
Copy link

@nickvsnetworking nickvsnetworking commented Oct 4, 2020

Title

Updated Readme to include more complete instructions on running S1AP tester

Summary

Updated the Readme file to include more information on compiling and running the code standalone. (ie as not part of the Magma test Suite and with other EPCs)

Test plan

No code changes, but copy-paste tested examples to confirm they work.
(Some issues compiling on current master but will opened separate PR for that with fix)

@facebook-github-bot facebook-github-bot added the CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. label Oct 4, 2020
@nickvsnetworking nickvsnetworking mentioned this pull request Oct 4, 2020
```
On successful compilation, the “libtfw.so” library gets generated under
TestCntlrApp/lib folder.
TestCntlrApp/lib folder which is copied to ``/usr/lib``.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

which is copied to => which needs to be / should be copied to
The copying of .so file does not happen automatically as part of compilation and needs to be done separately as shown in steps.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@VinashakAnkitAman Referring line number 56, libtfw.so is getting copied to /usr/lib
So sentence in line number 60 looks to be fine

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@VinashakAnkitAman Referring line number 56, libtfw.so is getting copied to /usr/lib
So sentence in line number 60 looks to be fine

@@ -53,18 +53,55 @@ S1APTester binary can be generated by executing below compilation steps:
$ cd TestCntlrApp/build
$ make cleanall
$ make
$ sudo cp ../lib/libtfw.so /usr/lib
$ cd ../../
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This statement is not needed here: cd ../../

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Instead of cd ../../, specify the path from the folder created from "git clone "
If get code by command "https://github.com/facebookexperimental/S1APTester.git" S1APTester is folder created. You can specify path from S1APTester


## Compile Traffic Generator
```
$ cd Trfgen/build
$ make clean
$ make
$ sudo cp ../lib/libtrfgen.so /usr/lib
$ cd ../../
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This statement is not needed here: cd ../../

```
On successful compilation, the “libtrfgen.so” library gets generated under
Trfgen/lib folder.
Trfgen/lib folder which is copied to ``/usr/lib``.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

which is copied to => which needs to be / should be copied to
The copying of so file does not happen automatically as part of compilation and needs to be done separately as shown in steps.

$ cd TestCntlrStub/build
$ make clean
$ make
$ cd ../bin/
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This statement is not needed here in the steps: cd ../bin/

$ sudo ./testCntrlr -f testCaseList_1.txt
```

Log messages will be shown on screen and in the text file ``log`` created in the same directory.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

screen => terminal

```
On successful compilation, the “libtfw.so” library gets generated under
TestCntlrApp/lib folder.
TestCntlrApp/lib folder which is copied to ``/usr/lib``.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@VinashakAnkitAman Referring line number 56, libtfw.so is getting copied to /usr/lib
So sentence in line number 60 looks to be fine

```
On successful compilation, the “libtfw.so” library gets generated under
TestCntlrApp/lib folder.
TestCntlrApp/lib folder which is copied to ``/usr/lib``.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@VinashakAnkitAman Referring line number 56, libtfw.so is getting copied to /usr/lib
So sentence in line number 60 looks to be fine

@@ -53,18 +53,55 @@ S1APTester binary can be generated by executing below compilation steps:
$ cd TestCntlrApp/build
$ make cleanall
$ make
$ sudo cp ../lib/libtfw.so /usr/lib
$ cd ../../
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When we compile S1ap tester code within magma_test VM, generated library libtfw.so is copied to path "/home/vagrant/s1ap-tester/bin".
Even I didn't locate libtfw.so file in path /usr/lib/
So in what context libtfw.so is copied to /usr/lib/?

Copy link
Member

@VinashakAnkitAman VinashakAnkitAman Dec 15, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In case of using S1APTester with normal magma setup, the steps of copying the libtfw.so file to /home/vagrant/s1ap-tester/bin/ is part of VM provisioning and the python scripts are importing directly from this path.

As of now, the stub binary "testCntrlr" is trying to search the libtfw.so file in default lib folders as the path is not specified with the binary. This is why we need to copy the .so file in /usr/lib/ folder.

@@ -53,18 +53,55 @@ S1APTester binary can be generated by executing below compilation steps:
$ cd TestCntlrApp/build
$ make cleanall
$ make
$ sudo cp ../lib/libtfw.so /usr/lib
$ cd ../../
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When we compile S1ap tester code within magma_test VM, generated library libtfw.so is copied to path "/home/vagrant/s1ap-tester/bin".
Even I didn't locate libtfw.so file in path /usr/lib/
So in what context libtfw.so is copied to /usr/lib/?

@@ -53,18 +53,55 @@ S1APTester binary can be generated by executing below compilation steps:
$ cd TestCntlrApp/build
$ make cleanall
$ make
$ sudo cp ../lib/libtfw.so /usr/lib
$ cd ../../
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Instead of cd ../../, specify the path from the folder created from "git clone "
If get code by command "https://github.com/facebookexperimental/S1APTester.git" S1APTester is folder created. You can specify path from S1APTester

Copy link
Contributor

@ulaskozat ulaskozat left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please make the requested changes.

@AdamIsrael
Copy link

Bump. This is a useful change to get landed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants