Events directory restructuring

[gpsimenos]

Summary of changes

mbed-os/events directory restructured according to the internal proposal.

• Public headers moved into mbed-os/events/events folder
• Include paths updated where necessary
• Unit tests moved into mbed-os/events/test/unit folder

This is the first in a series of PRs aiming to clean up the mbed-os directory structure. The intention is to create a consistent tree among mbed components which following the below structure:

[component name]
├── mbed_lib.json                  
├── [component name]               <- Public headers that can be accessed by the developers
│   ├── [public header 1].h 
|   └── [...]
├── internal                       <- Internal headers, available only inside Mbed OS sources
│   ├── [internal header 1].h
|   └── [...]
├── test                          
│   ├── <test suite one>
|   └── [...]
└── source                         
    ├── [source file 1].cpp
    └── [...]

Impact of changes

None

Migration actions required

None

---

Documentation

None

---

Pull request type

[X] Patch update (Bug fix / Target update / Docs update / Test update / Refactor)
[] Feature update (New feature / Functionality change / New API)
[] Major update (Breaking change E.g. Return code change / API behaviour change)

---

Test results

[] No Tests required for this change (E.g docs only update)
[X] Covered by existing mbed-os tests (Greentea or Unittest)
[] Tests / results supplied as part of this PR

---

Reviewers

@evedon

---

[evedon]

The greentea tests should be moved under events/ as well

[evedon]

For consistency we should also move the local tests from the source directory to events/test.

[ciarmcom]

@gpsimenos, thank you for your changes.
@evedon @ARMmbed/mbed-os-wan @ARMmbed/mbed-os-test @ARMmbed/mbed-os-ipcore @ARMmbed/mbed-os-core @ARMmbed/mbed-os-maintainers please review.

[gpsimenos]

@0xc0170 Can you please remove 'needs: review' label for now

[LDong-Arm]

@gpsimenos hope this removes it

[0xc0170]

Travis job for checking mbed.h include in this repo needs an update to follow the changing name of unit tests (test/unit).

[mbed-ci]

Test run: SUCCESS

Summary: 7 of 7 test jobs passed
Build number : 1
Build artifacts

[ladislas]

I'm really happy to see this change in directory structure! Does this mean that all unit tests will move to this new structure for their respectives components?

Regarding naming path, I'm wondering if using unity is "too specialized". What if we change the unit test framework to something else? My $0.02 is that just using unit makes it clear it's unit tests and allows for framework switch if needed.

[hugueskamba]

Regarding naming path, I'm wondering if using unity is "too specialized". What if we change the unit test framework to something else? My $0.02 is that just using unit makes it clear it's unit tests and allows for framework switch if needed.

This is also what I was going to say. So +1 for naming it unit instead of unity.

[hugueskamba]

I see you have events/test/unit/ and events/test/unity/. What do they each contain?

[hugueskamba]

Why don't we have

[component name]
├── mbed_lib.json                  
├── [public header 1].h
├── [public header 2].h
├── internal                       <- Internal headers, available only inside Mbed OS sources
│   ├── [internal header 1].h
|   └── [...]
├── test                          
│   ├── <test suite one>
|   └── [...]
└── source                         
    ├── [source file 1].cpp
    └── [...]

Having public headers inside in component_name/component_name/ feels a bit weird.
Can you explain why they are not simply in component_name/?

[gpsimenos]

I see you have events/test/unit/ and events/test/unity/. What do they each contain?

events/test/unity/ contains unit tests previously in the UNITTESTS top-level folder.
events/test/unit/ contains "local" unit tests previously in events/source.

[gpsimenos]

Why don't we have

[component name]
├── mbed_lib.json                  
├── [public header 1].h
├── [public header 2].h
├── internal                       <- Internal headers, available only inside Mbed OS sources
│   ├── [internal header 1].h
|   └── [...]
├── test                          
│   ├── <test suite one>
|   └── [...]
└── source                         
    ├── [source file 1].cpp
    └── [...]

Having public headers inside in component_name/component_name/ feels a bit weird.
Can you explain why they are not simply in component_name/?

It has been agreed to follow the yotta directory structure for components going forwards. In the yotta structure, public headers are located in component_name/component_name/.

[gpsimenos]

I'm really happy to see this change in directory structure! Does this mean that all unit tests will move to this new structure for their respectives components?

Regarding naming path, I'm wondering if using unity is "too specialized". What if we change the unit test framework to something else? My $0.02 is that just using unit makes it clear it's unit tests and allows for framework switch if needed.

I agree. Will change unity back to unit and find an alternative name for the "local" unit tests.

Unfortunately the naming has already been signed off. Currently, the only framework used for those tests is unity, and the name is indeed "specialized", but it can be changed when/if tests using additional frameworks are added or the existing tests are ported.

[evedon]

Closing for now as this is not ready.