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

Deprecate the Greentea metrics API #14914

Merged
merged 2 commits into from
Jul 23, 2021

Conversation

nicole-osaz
Copy link
Contributor

@nicole-osaz nicole-osaz commented Jul 12, 2021

Add the deprecated macro to where the Greentea metrics API is declared.

Fixes #14790

Summary of changes

The Greentea metrics API is no longer supported, so a deprecated macro has been added to where it is declared.

Impact of changes

Migration actions required

The Greentea metrics APIs are now deprecated. Any users of the Greentea metrics API should discontinue their use.

Documentation

We should also update the mbed-os-5-docs repo to remove any mention of Greentea metrics


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

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

Reviewers


@ciarmcom
Copy link
Member

@nicole-osaz, thank you for your changes.
@ARMmbed/mbed-os-test @ARMmbed/mbed-os-maintainers please review.

Patater
Patater previously approved these changes Jul 13, 2021
0xc0170
0xc0170 previously approved these changes Jul 13, 2021
@0xc0170
Copy link
Contributor

0xc0170 commented Jul 13, 2021

@nicole-osaz The CI is failing (the results will come in a bit). From the current logs, I was able to retrieve the error

./mbed-os/features/frameworks/greentea-client/greentea-client/greentea_metrics.h:16:77: error: expected ';' after top level declarator
11:39:07  MBED_DEPRECATED_SINCE("mbed-os-6.13", "Greentea metrics API are deprecated")

@Patater
Copy link
Contributor

Patater commented Jul 13, 2021

Looks we are missing a headerfile include:

#include "platform/mbed_toolchain.h"

@mbed-ci
Copy link

mbed-ci commented Jul 13, 2021

Jenkins CI Test : ❌ FAILED

Build Number: 1 | 🔒 Jenkins CI Job | 🌐 Logs & Artifacts

CLICK for Detailed Summary

jobs Status
jenkins-ci/mbed-os-ci_unittests ✔️
jenkins-ci/mbed-os-ci_build-cloud-example-ARM
jenkins-ci/mbed-os-ci_cmake-cloud-example-GCC_ARM ✔️
jenkins-ci/mbed-os-ci_cmake-cloud-example-ARM ✔️
jenkins-ci/mbed-os-ci_build-cloud-example-GCC_ARM
jenkins-ci/mbed-os-ci_cmake-example-ARM ✔️
jenkins-ci/mbed-os-ci_cmake-example-GCC_ARM ✔️
jenkins-ci/mbed-os-ci_build-greentea-GCC_ARM
jenkins-ci/mbed-os-ci_build-example-ARM
jenkins-ci/mbed-os-ci_build-greentea-ARM
jenkins-ci/mbed-os-ci_build-example-GCC_ARM

@mergify mergify bot dismissed stale reviews from Patater and 0xc0170 July 14, 2021 14:42

Pull request has been modified.

@Patater
Copy link
Contributor

Patater commented Jul 16, 2021

Rebased to apply the fixup commit

Patater
Patater previously approved these changes Jul 16, 2021
@mergify mergify bot dismissed Patater’s stale review July 16, 2021 08:09

Pull request has been modified.

@Patater
Copy link
Contributor

Patater commented Jul 16, 2021

CI started

@mbed-ci
Copy link

mbed-ci commented Jul 16, 2021

Jenkins CI Test : ✔️ SUCCESS

Build Number: 2 | 🔒 Jenkins CI Job | 🌐 Logs & Artifacts

CLICK for Detailed Summary

jobs Status
jenkins-ci/mbed-os-ci_unittests ✔️
jenkins-ci/mbed-os-ci_build-cloud-example-ARM ✔️
jenkins-ci/mbed-os-ci_cmake-cloud-example-ARM ✔️
jenkins-ci/mbed-os-ci_cmake-cloud-example-GCC_ARM ✔️
jenkins-ci/mbed-os-ci_build-cloud-example-GCC_ARM ✔️
jenkins-ci/mbed-os-ci_build-greentea-ARM ✔️
jenkins-ci/mbed-os-ci_build-greentea-GCC_ARM ✔️
jenkins-ci/mbed-os-ci_build-example-GCC_ARM ✔️
jenkins-ci/mbed-os-ci_cmake-example-GCC_ARM ✔️
jenkins-ci/mbed-os-ci_cmake-example-ARM ✔️
jenkins-ci/mbed-os-ci_build-example-ARM ✔️
jenkins-ci/mbed-os-ci_greentea-test ✔️

Patater
Patater previously approved these changes Jul 16, 2021
@Patater Patater requested a review from 0xc0170 July 16, 2021 09:52
0xc0170
0xc0170 previously approved these changes Jul 16, 2021
@0xc0170
Copy link
Contributor

0xc0170 commented Jul 16, 2021

@nicole-osaz Can you add license header via a new pull request? I realized this file does not have any

@mergify mergify bot dismissed stale reviews from Patater and 0xc0170 July 16, 2021 13:23

Pull request has been modified.

@0xc0170
Copy link
Contributor

0xc0170 commented Jul 16, 2021

Please rebase instead of merging (remove 2a6b7c2 merge commit)

@Patater
Copy link
Contributor

Patater commented Jul 16, 2021

CI started

@mbed-ci
Copy link

mbed-ci commented Jul 16, 2021

Jenkins CI Test : ✔️ SUCCESS

Build Number: 3 | 🔒 Jenkins CI Job | 🌐 Logs & Artifacts

CLICK for Detailed Summary

jobs Status
jenkins-ci/mbed-os-ci_unittests ✔️
jenkins-ci/mbed-os-ci_cmake-cloud-example-ARM ✔️
jenkins-ci/mbed-os-ci_cmake-cloud-example-GCC_ARM ✔️
jenkins-ci/mbed-os-ci_build-cloud-example-GCC_ARM ✔️
jenkins-ci/mbed-os-ci_build-cloud-example-ARM ✔️
jenkins-ci/mbed-os-ci_build-greentea-ARM ✔️
jenkins-ci/mbed-os-ci_build-greentea-GCC_ARM ✔️
jenkins-ci/mbed-os-ci_cmake-example-GCC_ARM ✔️
jenkins-ci/mbed-os-ci_cmake-example-ARM ✔️
jenkins-ci/mbed-os-ci_build-example-ARM ✔️
jenkins-ci/mbed-os-ci_build-example-GCC_ARM ✔️
jenkins-ci/mbed-os-ci_greentea-test ✔️

@@ -7,11 +26,13 @@
/**
* Setup platform specific metrics
*/
MBED_DEPRECATED_SINCE("mbed-os-6.13", "Greentea metrics API are deprecated")
Copy link
Contributor

Choose a reason for hiding this comment

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

We released mbed-os-6.13 today, so the starting version will be mbed-os-6.14

Copy link
Contributor

Choose a reason for hiding this comment

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

Correct, lets fix it

@@ -7,11 +26,13 @@
/**
* Setup platform specific metrics
*/
MBED_DEPRECATED_SINCE("mbed-os-6.13", "Greentea metrics API are deprecated")
Copy link
Contributor

Choose a reason for hiding this comment

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

Correct, lets fix it

@mergify mergify bot dismissed 0xc0170’s stale review July 20, 2021 09:04

Pull request has been modified.

Add the deprecated macro to where the Greentea metrics API is declared.

Fixes ARMmbed#14790
Add missing license header to greentea_metrics.h
@Patater
Copy link
Contributor

Patater commented Jul 20, 2021

Rebased to apply fixup commit

@Patater
Copy link
Contributor

Patater commented Jul 20, 2021

CI started

@mbed-ci
Copy link

mbed-ci commented Jul 20, 2021

Jenkins CI Test : ✔️ SUCCESS

Build Number: 4 | 🔒 Jenkins CI Job | 🌐 Logs & Artifacts

CLICK for Detailed Summary

jobs Status
jenkins-ci/mbed-os-ci_unittests ✔️
jenkins-ci/mbed-os-ci_build-cloud-example-ARM ✔️
jenkins-ci/mbed-os-ci_cmake-cloud-example-ARM ✔️
jenkins-ci/mbed-os-ci_build-cloud-example-GCC_ARM ✔️
jenkins-ci/mbed-os-ci_cmake-cloud-example-GCC_ARM ✔️
jenkins-ci/mbed-os-ci_build-greentea-ARM ✔️
jenkins-ci/mbed-os-ci_build-greentea-GCC_ARM ✔️
jenkins-ci/mbed-os-ci_cmake-example-GCC_ARM ✔️
jenkins-ci/mbed-os-ci_build-example-ARM ✔️
jenkins-ci/mbed-os-ci_cmake-example-ARM ✔️
jenkins-ci/mbed-os-ci_build-example-GCC_ARM ✔️
jenkins-ci/mbed-os-ci_greentea-test ✔️

@Patater Patater merged commit c8b889e into ARMmbed:master Jul 23, 2021
@mergify mergify bot added release version missing When PR does not contain release version, bot should label it and we fix it afterwards and removed ready for merge labels Jul 23, 2021
@mergify
Copy link

mergify bot commented Jul 23, 2021

This PR does not contain release version label after merging.

@0xc0170 0xc0170 added release-type: patch Indentifies a PR as containing just a patch and removed release version missing When PR does not contain release version, bot should label it and we fix it afterwards labels Jul 23, 2021
@0xc0170
Copy link
Contributor

0xc0170 commented Jul 23, 2021

Fixed

@mbedmain mbedmain added release-version: 6.14.0 Release-pending and removed release-type: patch Indentifies a PR as containing just a patch Release-pending labels Aug 18, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

greentea-client "metrics" API is unused
7 participants