Skip to content

Commit 34284fd

Browse files
tempateLuciaEchevarria99
authored andcommitted
Remove the obsolete YAML validator
Signed-off-by: tempate <danieldiaz@eprosima.com>
1 parent 58b14b5 commit 34284fd

35 files changed

Lines changed: 2 additions & 1616 deletions

.dev/README.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,6 @@ The modules contained in this repository are the following:
3434
* **ddsrouter_docs** (hosted in directory `docs`)
3535
This package contains the user documentation built with sphinx.
3636

37-
* **ddsrouter_yaml_validator** This is an application used for validating DDS Router `yaml` configuration files.
38-
3937
This is the dependency graph of the packages:
4038

4139
```sh

.github/docker/ddsrouter/Dockerfile

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,9 +35,7 @@ RUN pip3 install \
3535
colcon-mixin \
3636
lxml \
3737
vcstool \
38-
GitPython \
39-
pyyaml \
40-
jsonschema
38+
GitPython
4139

4240
WORKDIR /ddsrouter
4341

README.md

Lines changed: 0 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -68,8 +68,6 @@ environment are provided below. These installation instructions are a summarized
6868
* [CMake](https://cmake.org/), [g++](https://gcc.gnu.org/), [pip](https://pypi.org/project/pip/), [wget](https://www.gnu.org/software/wget/) and [git](https://git-scm.com/)
6969
* [Colcon](https://colcon.readthedocs.io/en/released/) [optional, not required for CMake-only installation]
7070
* [Gtest](https://github.com/google/googletest) [for test only]
71-
* [PyYAML](https://pyyaml.org/) [for YAML Validator only]
72-
* [jsonschema](https://python-jsonschema.readthedocs.io/) [for YAML Validator only]
7371

7472
#### CMake, g++, pip, wget and git
7573

@@ -98,28 +96,6 @@ compile tests. It is possible to activate them with the opportune [CMake options
9896
[CMake](https://cmake.org/). For a detailed description of the Gtest installation process, please refer to the
9997
[Gtest Installation Guide](https://github.com/google/googletest).
10098

101-
#### PyYAML
102-
103-
[PyYAML](https://pyyaml.org/) is a YAML parser and emitter for Python.
104-
It is used by the DDS-Router YAML Validator for loading the content of configuration files.
105-
Install `pyyaml` by executing the following command:
106-
107-
```bash
108-
pip3 install -U pyyaml
109-
```
110-
111-
#### jsonschema
112-
113-
[jsonschema](https://python-jsonschema.readthedocs.io/) is an implementation of the JSON Schema specification for
114-
Python.
115-
It is used by the DDS-Router YAML Validator for performing validation of configuration files against a given JSON
116-
schema.
117-
Install `jsonschema` by executing the following command:
118-
119-
```bash
120-
pip3 install -U jsonschema
121-
```
122-
12399
### Dependencies
124100

125101
#### Asio and TinyXML2 libraries
@@ -189,7 +165,6 @@ These packages are:
189165
* `ddsrouter_yaml`: library to configure a DDS Router from a YAML.
190166
* `ddsrouter_tool`: application to execute a DDS Router from a YAML configuration file.
191167
* `ddsrouter_docs`: package to generate the DDS Router documentation using sphinx.
192-
* `ddsrouter_yaml_validator`: application to validate DDS Router YAML configuration files.
193168

194169
> *NOTE:* Those packages could be installed and use independently (according with each package dependency).
195170
In order to compile only a package and its dependencies, use the colcon argument `--packages-up-to <package>`.
@@ -209,18 +184,6 @@ source <install-path>/setup.bash
209184
./<install-path>/ddsrouter_tool/bin/ddsrouter
210185
```
211186

212-
### Validate a configuration file
213-
214-
To validate a *DDS Router* YAML configuration file, execute the following commands:
215-
216-
```bash
217-
# Source installation
218-
source <install-path>/setup.bash
219-
220-
# Validate a DDS Router configuration file
221-
ddsrouter_yaml_validator --config-file ddsrouter-config.yaml
222-
```
223-
224187
### Testing
225188

226189
By default, *DDS Router* does not compile tests. However, they can be activated by downloading and installing

docs/index.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,6 @@
5050
Participant </rst/user_manual/participants/participant>
5151
/rst/user_manual/configuration
5252
/rst/user_manual/wan_configuration
53-
/rst/user_manual/yaml_validator
5453
/rst/user_manual/user_manual_glossary
5554

5655

docs/rst/developer_manual/installation/sources/linux.rst

Lines changed: 0 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -47,8 +47,6 @@ installed in the system:
4747
* :ref:`cmake_gcc_pip_wget_git_sl`
4848
* :ref:`colcon_install` [optional]
4949
* :ref:`gtest_sl` [for test only]
50-
* :ref:`py_yaml` [for YAML Validator only]
51-
* :ref:`json_schema` [for YAML Validator only]
5250

5351

5452
.. _cmake_gcc_pip_wget_git_sl:
@@ -104,40 +102,6 @@ Use the following command to download the code:
104102
105103
git clone --branch release-1.12.0 https://github.com/google/googletest src/googletest-distribution
106104
107-
108-
.. _py_yaml:
109-
110-
PyYAML
111-
^^^^^^
112-
113-
`PyYAML <https://pyyaml.org/>`_ is a YAML parser and emitter for Python.
114-
115-
It is used by the DDS-Router :ref:`yaml_validator` for loading the content of configuration files.
116-
117-
Install ``pyyaml`` by executing the following command:
118-
119-
.. code-block:: bash
120-
121-
pip3 install -U pyyaml
122-
123-
124-
.. _json_schema:
125-
126-
jsonschema
127-
^^^^^^^^^^
128-
129-
`jsonschema <https://python-jsonschema.readthedocs.io/>`_ is an implementation of the JSON Schema specification for
130-
Python.
131-
132-
It is used by the DDS-Router :ref:`yaml_validator` for performing validation of configuration files against a given
133-
JSON schema.
134-
135-
Install ``jsonschema`` by executing the following command:
136-
137-
.. code-block:: bash
138-
139-
pip3 install -U jsonschema
140-
141105
.. _dependencies:
142106

143107
Dependencies

docs/rst/developer_manual/installation/sources/windows.rst

Lines changed: 0 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -50,8 +50,6 @@ installed in the system:
5050
* :ref:`windows_sources_cmake_pip3_wget_git`
5151
* :ref:`windows_sources_colcon_install` [optional]
5252
* :ref:`windows_sources_gtest` [for test only]
53-
* :ref:`windows_py_yaml` [for YAML Validator only]
54-
* :ref:`windows_json_schema` [for YAML Validator only]
5553

5654
.. _windows_sources_visual_studio:
5755

@@ -127,40 +125,6 @@ or refer to the
127125
`Gtest Installation Guide <https://github.com/google/googletest>`_ for a detailed description of the Gtest installation
128126
process.
129127

130-
131-
.. _windows_py_yaml:
132-
133-
PyYAML
134-
^^^^^^
135-
136-
`PyYAML <https://pyyaml.org/>`_ is a YAML parser and emitter for Python.
137-
138-
It is used by the DDS-Router :ref:`yaml_validator` for loading the content of configuration files.
139-
140-
Install ``pyyaml`` by executing the following command:
141-
142-
.. code-block:: bash
143-
144-
pip3 install -U pyyaml
145-
146-
147-
.. _windows_json_schema:
148-
149-
jsonschema
150-
^^^^^^^^^^
151-
152-
`jsonschema <https://python-jsonschema.readthedocs.io/>`_ is an implementation of the JSON Schema specification for
153-
Python.
154-
155-
It is used by the DDS-Router :ref:`yaml_validator` for performing validation of configuration files against a given
156-
JSON schema.
157-
158-
Install ``jsonschema`` by executing the following command:
159-
160-
.. code-block:: bash
161-
162-
pip3 install -U jsonschema
163-
164128
.. _windows_sources_dependencies:
165129

166130
Dependencies

docs/rst/notes/previous_versions/v0.4.0.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Version v0.4.0
44

55
This release includes the following **features**:
66

7-
* New :ref:`yaml_validator`, a simple tool to assert the correctness of DDS Router configuration files.
7+
* New *Yaml Validator*, a simple tool to assert the correctness of DDS Router configuration files.
88
* New :ref:`user_manual_user_interface_version_argument` to show the current version of DDS Router.
99

1010
This release includes the following **improvementes**:

docs/rst/spelling_wordlist.txt

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,6 @@ gMock
2727
Gtest
2828
guid
2929
IPv
30-
jsonschema
3130
kubernetes
3231
localhost
3332
metatraffic
@@ -41,7 +40,6 @@ Requiredness
4140
runtime
4241
scalable
4342
utils
44-
validator
4543
Vulcanexus
4644
wget
4745
yaml

docs/rst/user_manual/yaml_validator.rst

Lines changed: 0 additions & 29 deletions
This file was deleted.

tools/ddsrouter_yaml_validator/.gitignore

Lines changed: 0 additions & 98 deletions
This file was deleted.

0 commit comments

Comments
 (0)