Update S11: Practice 3 authored by Rodrigo's avatar Rodrigo
......@@ -3,7 +3,7 @@
# Session 11: Practice 3
* **Time**: 2h
* **Date**: Wednesday, March-09th-2022
* **Date**: XXXX, XX-XX-2023
* **Goals**:
* Practicing on the programming of servers
* Develop our own server for working with DNA sequences
......@@ -27,19 +27,19 @@
## Introduction
The goal of this practice is to develop our own **Seq** server for working with **DNA sequences**. We have been working with DNA sequences for many sessions, but always in our local computer. Now we will make these calculations available to other applications on Internet
The goal of this new assignment is to develop our own **Seq** server to work with **DNA sequences**. We have been working with DNA sequences for many sessions, but always in our local computer. Now we will make these calculations available to other applications on Internet
The first step is to **define** the set of **rules** and **commands** that the **clients** need to follow in order to access the **services** given by our **server**: we should define the **protocol**
| Service name | Request message | Argument | Response message | Description |
|--------------|-----------------|----------|------------------|-------------|
| **PING** | "PING" | none | "OK" | Ping service for testing if the server is alive of not |
| **GET** | "GET n" | n: 0-4 | A sequence | Get the sequence n. It could be any valid sequence of any length. There are only 5 sequences, numbered from 0 to 4 |
| **INFO** | "INFO seq" | seq: A sequence | See format below | Get information about the given sequence: total length, number of bases and their percentages |
| **COMP** | "COMP seq" | seq: A sequene | The complement sequence | Calculate the complement of the given sequence |
| **REV** | "REV seq" | seq: A sequence | The reverse sequence | Calculate the reverse of the given sequence |
| **GENE** | "GENE name" | Gene name. See format below | The sequence of the gene | Get the complete sequence of the given GENE |
| **PING** | "PING" | none | "OK" | Ping service for testing whether the server is alive of not |
| **GET** | "GET n" | n: 0-4 | A sequence | Gets sequence n. It could be any valid sequence of any length. There are only 5 sequences, numbered from 0 to 4 |
| **INFO** | "INFO seq" | seq: A sequence | See format below | Gets information about a specific sequence: total length, number of bases, and their percentages |
| **COMP** | "COMP seq" | seq: A sequene | The complement sequence | Calculates the complement of a specific sequence |
| **REV** | "REV seq" | seq: A sequence | The reverse sequence | Calculatea the reverse of a specific sequence |
| **GENE** | "GENE name" | Gene name. See format below | The sequence of the gene | Gets the complete sequence of a specific GENE |
The response message returned by the **INFO** service should be like this example:
The response message returned by the **INFO** service should be like in the following example:
```
Sequence: ATAGACCAAACATGAGAGGCT
......@@ -50,155 +50,153 @@ G: 5 (23.8%)
T: 3 (14.3%)
```
The names of the genes that are **valid** when calling the **GENE service** are: **U5**, **ADA**, **FRAT1**, **FXN**, **RNU6_269P**
The names of the **valid** genes to call the **GENE service** are: **U5**, **ADA**, **FRAT1**, **FXN**, and **RNU6_269P**
The server will be programmed **step by step**, following the guides given in the **exercises**
The server will be programmed **step by step**, following the guidelines given in the **exercises**.
## Localhost IP address
There is a special **IP** address: **127.0.0.1**, which is used to identify **your local machines**. When programming a server, instead of having to used the real IP, it is\*\* easier to use this IP. Doing so, you do not have to change the code when running the server in a different computer
There is a special **IP** address: **127.0.0.1**, which is used to identify **your local machines**. When programming a server, instead of having to used the real IP, it is much easier to use this IP. By doing so, you do not have to change the code when running the server in a different computer.
**We will always use the 127.0.0.1 address** in our servers
**We will always use the 127.0.0.1 address** in our local servers.
## Exercises
We will implement the **Seq Server** and develop some example clients for testing it. While developing the server, we will use the **printf** and **nc** linux commands for **sending messages** to the **server**. But you can also do it from your own client, if you like
We will implement the **Seq Server**, and develop some clients to test it. While developing the server, we will use the **echo** and **nc** linux commands for **sending messages** to the **server**. But you can also do it from your own client if you like.
The server will be stored in the **Seq-Server.py file** inside **folder P3**
you should use the **Seq1 module** developed in **practice 1**
The server will be stored in a file called **Seq-Server.py** within a folder with name **P03**. You will need to use the **Seq1 module** developed in **P01**, and extend it.
### Exercise 1: PING
* **Filename:** P3/Seq-Server.py
* **Filename:** P03/Seq-server.py
Let's start by programming a server that implements the **PING command**. The client will send a message with the word **PING**. Then, the server should **parse** the request message. If the PING command is **detected**, it should generate the response message **"OK!\\n"**. Also, it should **print on the console** the message "PING command!" in GREEN, and then the response message in white
Let's start programming a server that implements the **PING command**. The client will send a message with the word **PING**; then, the server **parses** the request message so if the PING command is **detected**, it generates the response message **"OK!\\n"**. Also, it needs to **print on the console** the message "PING command!" in green, and then the response message in white.
For **testing the server** we use this command, executed from the **command line**:
For **testing the server** we can use the following command:
```
printf "PING" | nc 127.0.0.1 8080
echo "PING" | nc 127.0.0.1 8080
```
This is what we will see on the **linux console**:
![](https://github.com/myTeachingURJC/2019-2020-PNE/raw/master/s11-client-server-4/exercises-01.png)
![](https://gitlab.etsit.urjc.es/rperez/pne-wiki/-/raw/master/s10-client-server-3/1-client-server-4/exercises-01.png)
And this is what we should get in the **Server's console**:
![](https://github.com/myTeachingURJC/2019-2020-PNE/raw/master/s11-client-server-4/exercises-02.png)
![](https://gitlab.etsit.urjc.es/rperez/pne-wiki/-/raw/master/s10-client-server-3/1-client-server-4/exercises-02.png)
### Exercise 2: GET
* **Filename:** P3/Seq-Server.py
* **Filename:** P03/Seq-Server.py
Modify the Seq server for implementing the **GET command**. The client sends a message with the word **GET** followed by a **number** between **0** and **4**. The server will return a **response message** with a **sequence** associated to that number. These sequences are for testing purposes, therefore you can use whatever sequences you want. They should be stored into a **list**. The server uses the number received in the GET command for accessing this list and **returning the sequence**
Modify the Seq-server to implement the **GET command**. The client sends a message with the word **GET** followed by a **number** between **0** and **4**. The server will return a **response message** with a **sequence** associated to that number. These sequences are for testing purposes, so you can use whatever sequences you want; stored them into a **list** that the server uses to index with the received parameter.
For **testing the server** we use this command, executed from the **command line**:
Use the following command to test the server:
```
printf "GET 2" | nc 127.0.0.1 8080
echo "GET 2" | nc 127.0.0.1 8080
```
In this example the client is asking for the sequence number 2
In this example the client is asking for the sequence number 2.
This is what is shown in the **Linux's console**:
![](https://github.com/myTeachingURJC/2019-2020-PNE/raw/master/s11-client-server-4/exercises-03.png)
![](https://gitlab.etsit.urjc.es/rperez/pne-wiki/-/raw/master/s10-client-server-3/1-client-server-4/exercises-03.png)
And this is what we should get in the **Server's console**:
![](https://github.com/myTeachingURJC/2019-2020-PNE/raw/master/s11-client-server-4/exercises-04.png)
![](https://gitlab.etsit.urjc.es/rperez/pne-wiki/-/raw/master/s10-client-server-3/1-client-server-4/exercises-04.png)
### Exercise 3: INFO
* **Filename:** P3/Seq-Server.py
* **Filename:** P03/Seq-server.py
Modify the Seq server for implementing the **INFO command**. The client sends a message with the word **INFO** followed by a sequence. The server will return a **response message** with information about that sequence. This information should be obtained using the **Seq Class**
Modify the Seq server for implementing the **INFO command**. The client sends a message with the word **INFO** followed by a sequence. The server will return a **response message** with information about that sequence. This information should be obtained using the **Seq Class**.
For **testing the server** we use commands like this, executed from the **Linux's command line**:
For **testing the server** we can use use the following command:
```
printf "INFO AACCGTA" | nc 127.0.0.1 8080
echo "INFO AACCGTA" | nc 127.0.0.1 8080
```
This is what is shown in the **Linux's console**:
![](https://github.com/myTeachingURJC/2019-2020-PNE/raw/master/s11-client-server-4/exercises-05.png)
![](https://gitlab.etsit.urjc.es/rperez/pne-wiki/-/raw/master/s10-client-server-3/1-client-server-4/exercises-05.png)
And this is what we should get in the **Server's console**:
![](https://github.com/myTeachingURJC/2019-2020-PNE/raw/master/s11-client-server-4/exercises-06.png)
![](https://gitlab.etsit.urjc.es/rperez/pne-wiki/-/raw/master/s10-client-server-3/1-client-server-4/exercises-06.png)
### Exercise 4: COMP
* **Filename:** P3/Seq-Server.py
* **Filename:** P03/Seq-server.py
Modify the Seq server for implementing the **COMP command**. The client sends a message with the word **COMP** followed by a sequence. The server will return a **response message** with the complement of that sequence. It should be obtained using the **Seq Class**
Upgrade the Seq server to respond to the **COMP command**. The client sends a message with the word **COMP** followed by a sequence. The server will return a **response message** with the complement of that sequence. It must be obtained using the **Seq Class**.
For **testing the server** we use commands like this, executed from the **Linux's command line**:
Use the following command to test the server:
```
printf "COMP AACCGTA" | nc 127.0.0.1 8080
echo "COMP AACCGTA" | nc 127.0.0.1 8080
```
This is what is shown in the **Linux's console**:
![](https://github.com/myTeachingURJC/2019-2020-PNE/raw/master/s11-client-server-4/exercises-07.png)
![](https://gitlab.etsit.urjc.es/rperez/pne-wiki/-/raw/master/s10-client-server-3/1-client-server-4/exercises-07.png)
And this is what we should get in the **Server's console**:
![](https://github.com/myTeachingURJC/2019-2020-PNE/raw/master/s11-client-server-4/exercises-08.png)
![](https://gitlab.etsit.urjc.es/rperez/pne-wiki/-/raw/master/s10-client-server-3/1-client-server-4/exercises-08.png)
### Exercise 5: REV
* **Filename:** P3/Seq-Server.py
* **Filename:** P03/Seq-server.py
Modify the Seq server for implementing the **REV command**. The client sends a message with the word **REV** followed by a sequence. The server will return a **response message** with the reverse of the given sequence. It should be obtained using the **Seq Class**
Modify the Seq server and implement the **REV command**. The client sends a message with the word **REV** followed by a sequence. The server will return a **response message** with the reverse of the sequence. It must be obtained using the **Seq Class**.
For **testing the server** we use commands like this, executed from the **Linux's command line**:
Use the following command to test the server:
```
printf "REV AACCGTA" | nc 127.0.0.1 8080
echo "REV AACCGTA" | nc 127.0.0.1 8080
```
This is what is shown in the **Linux's console**:
![](https://github.com/myTeachingURJC/2019-2020-PNE/raw/master/s11-client-server-4/exercises-09.png)
![](https://gitlab.etsit.urjc.es/rperez/pne-wiki/-/raw/master/s10-client-server-3/1-client-server-4/exercises-09.png)
And this is what we should get in the **Server's console**:
![](https://github.com/myTeachingURJC/2019-2020-PNE/raw/master/s11-client-server-4/exercises-10.png)
![](https://gitlab.etsit.urjc.es/rperez/pne-wiki/-/raw/master/s10-client-server-3/1-client-server-4/exercises-10.png)
### Exercise 6: GENE
* **Filename:** P3/Seq-Server.py
Modify the Seq server for implementing the **GENE command**. The client sends a message with the word **REV** followed by a **gene name**: U5, ADA, FRAT1, FXN or RNU6_269P. The server will return a **response message** with the complete sequence of that gene. It should be obtained using the **Seq Class** (and reading the gene from the corresponding file)
Work on the Seq server and implementing the **GENE command**. The client sends a message with the word **GENE** followed by a **gene name**: U5, ADA, FRAT1, FXN, or RNU6_269P. The server will return a **response message** with the whole sequence corresponding to that gene. It must be obtained using the **Seq Class** (and reading the gene from the corresponding file).
For **testing the server** we use commands like this, executed from the **Linux's command line**:
Use the following command to test the server:
```
printf "GENE U5" | nc 127.0.0.1 8080
echo "GENE U5" | nc 127.0.0.1 8080
```
This is what is shown in the **Linux's console**:
![](https://github.com/myTeachingURJC/2019-2020-PNE/raw/master/s11-client-server-4/exercises-11.png)
![](https://gitlab.etsit.urjc.es/rperez/pne-wiki/-/raw/master/s10-client-server-3/1-client-server-4/exercises-11.png)
And this is what we should get in the **Server's console**:
![](https://github.com/myTeachingURJC/2019-2020-PNE/raw/master/s11-client-server-4/exercises-12.png)
![](https://gitlab.etsit.urjc.es/rperez/pne-wiki/-/raw/master/s10-client-server-3/1-client-server-4/exercises-12.png)
### Exercise 7: Test client
* **Filename:** P3/test-client.py
* **Filename:** P03/test-client.py
Finally let's create a client for **testing our server**. You should use the **Client class** from **practice 2**. Use the **talk** method
Finally let's create a client to **test our server**. You must use the **Client class** from **P02** and the **talk** method.
For the services **INFO**, **COMP** and **REV**, use the sequence obtained when calling the **GET 0 command**
For the services **INFO**, **COMP** and **REV**, use the sequence obtained when calling the **GET 0** command.
The client should **write messages on the console** indicating the test it is performing and the response obtained from the server:
The client should **write messages on the console** indicating the test it is performing along with the response obtained from the server:
```
-----| Practice 3, Exercise 7 |------
......@@ -260,22 +258,21 @@ Process finished with exit code 0
## END of the session
The session is finished. Make sure, during this week, that everything in this list is checked!
The session is finished. Make sure during this week that everything in this list is checked!
* [ ] You have all the items of the session 10 checked!
* [ ] Your working repo contains the **P3 Folder** with the following files:
* [ ] You have all the items of S10 checked!
* [ ] Your working repo contains the **P03** folder with the following files:
* [ ] Seq-server.py
* [ ] test-client.py
* [ ] All the previous files have been pushed to your remote Github repo
* [ ] All the previous files have been pushed to your remote Gitlab repo
# Credits
* [Juan González-Gómez](https://github.com/Obijuan) (Obijuan)
* [Alvaro del Castillo](https://github.com/acs). He designed and created the original content of this subject. Thanks a lot :-)
* Rodrigo Pérez Rodríguez
# License
![](https://github.com/Obijuan/digital-electronics-with-open-FPGAs-tutorial/raw/master/wiki/portada/attribution-share-alike-creative-commons-license.png)
![](https://gitlab.etsit.urjc.es/rperez/PNE/-/raw/master/Cover/attribution-share-alike-creative-commons-license.png)
# Links
......
......