Improve bmcweb CLI app

Enhance bmcweb CLI app error messages. Replace the loglevel flag with a
subcommand called "loglevel". Handle case where empty log levels were
being propagated to bmcwebd.

Inv

Improve bmcweb CLI app

Enhance bmcweb CLI app error messages. Replace the loglevel flag with a
subcommand called "loglevel". Handle case where empty log levels were
being propagated to bmcwebd.

Invalid logging values are handled by the CLI. List of available states
can be determined by using the command:
bmcweb loglevel -h

Example:
bmcweb loglevel DEBUG
bmcweb loglevel debug

Change-Id: Iaac3f674109e5d86f6c0cd7c1b930ee1c9c594e2
Signed-off-by: Aushim Nagarkatti <anagarkatti@nvidia.com>

show more ...

Enable bmcweb dynamic logging

Create a CLI app called "bmcweb" that can set logging levels on
"bmcwebd", the new bmcweb daemon. Create a dbus connection to set log
level using the CLI app Define th

Enable bmcweb dynamic logging

Create a CLI app called "bmcweb" that can set logging levels on
"bmcwebd", the new bmcweb daemon. Create a dbus connection to set log
level using the CLI app Define the "setLogLevel" method on dbus to
control logging level in bmcwebd Add logic to move logging level from
build option to dynamic overloading

Reason: bmcweb picks up logging level as a compile flag. We want it to
be more flexible to debug errors in the field. Using the bmcweb CLI
app, we can set log levels on the bmcweb daemon during runtime.
Splitting bmcweb.

For example, to set logging level to INFO on the target:
bmcweb -l INFO

Change-Id: I7192e4d0ac7aa3a91babecc473521be27ea8acd1
Signed-off-by: Aushim Nagarkatti <anagarkatti@nvidia.com>

show more ...

Fix spelling mistakes

These were found with:
codespell -w $(git ls-files | grep "\.[hc]\(pp\)\?$")

At some point in the future, we might want to get this enabled in CI.

Change-Id: Iccb57b2adfd06a2

Fix spelling mistakes

These were found with:
codespell -w $(git ls-files | grep "\.[hc]\(pp\)\?$")

At some point in the future, we might want to get this enabled in CI.

Change-Id: Iccb57b2adfd06a2e177e99db2923fe4e8e329118
Signed-off-by: Ed Tanous <ed@tanous.net>

show more ...

Update Logging option for the setting log level

In order to be able to more easily debug bmcweb related issue,
a new meson option is added to set a specific logging level
Which generates the targete

Update Logging option for the setting log level

In order to be able to more easily debug bmcweb related issue,
a new meson option is added to set a specific logging level
Which generates the targeted logging traces rather than all of
debug traces.

The current option -Dbmcweb-logging which can be either
disabled or enabled is changed to allow to set the log level
for the specific level traces (e.g. error or critical traces)
to be written to the journal.

-Dbmcweb-logging=<log-level>

where <log-level> can be disabled, enabled, debug, info,
warning, error, or critical.

- `disabled`: Turns off all bmcweb log traces.
- `enabled` : treated as `debug`
- Other option can be described in
[Logging Levels](DEVELOPING.md).

For an example, to enable only 'error', 'critical' log
entries, bmcweb can be built with

-Dbmcweb-logging=error

Testing:
- Verified that only the specific logs (e.g. error and
critical logs) were displayed by compiling bmcweb with the
specific bmcweb-logging level.

Change-Id: I522ca26700ea420fee1a5cf688d3e8c6661f2f55
Signed-off-by: Myung Bae <myungbae@us.ibm.com>

show more ...

Attempt to document logging levels

List the 5 logging levels. Attempt to document what each does and some
example use cases.

We have a use case where we want to log internal bmcweb errors. debug is

Attempt to document logging levels

List the 5 logging levels. Attempt to document what each does and some
example use cases.

We have a use case where we want to log internal bmcweb errors. debug is
way too chatty. Want to be able to select the logging level. This is the
documentation for that end goal.

These are loosely followed today and more patches will come to move some
traces to the appropriate level.

In our use case, we don't want to be blown up by a fuzz tester but do
want internal errors. This is the difference between error logging level
and warning logging level. Warning is used for 4xx (e.g. 404) and error
is used for 5xx.

Plan to write a tool to walk the redfish tree and try random Redfish ids
and/or try a open source fuzzing tool. The logging for these 404s should
be warning.

Moved the ## Debug logging section from the README.md to this
DEVELOPING.md. Wanted the logging all together but didn't think we had
enough for a LOGGING.md and README seems too high level for this detail.

Tested: Pushed to my fork and formatting looked good.

Change-Id: I9713a4e674b3f519fec3f3caac0178af8d8d73a8
Signed-off-by: Gunnar Mills <gmills@us.ibm.com>

show more ...

Have clang-tidy header match others

This section isn't any more important than the others.

Tested: Doc change. Pushed to fork, looked good.

Change-Id: If9e888aff92dc389183f8a53527e603d1c685ad0
Sig

Have clang-tidy header match others

This section isn't any more important than the others.

Tested: Doc change. Pushed to fork, looked good.

Change-Id: If9e888aff92dc389183f8a53527e603d1c685ad0
Signed-off-by: Gunnar Mills <gmills@us.ibm.com>

show more ...

Switch Developing to say webui-vue

phosphor-webui is End of Life.
Like other documentation switch to webui-vue.

Tested: Pushed to my fork and looked good.

Change-Id: I81d559e7515e24d207856e2cc2b2d

Switch Developing to say webui-vue

phosphor-webui is End of Life.
Like other documentation switch to webui-vue.

Tested: Pushed to my fork and looked good.

Change-Id: I81d559e7515e24d207856e2cc2b2d0086bf7b3f1
Signed-off-by: Gunnar Mills <gmills@us.ibm.com>

show more ...

markdownlint: fix all warnings

Signed-off-by: Patrick Williams <patrick@stwcx.xyz>
Change-Id: I1402cbd84c916792ca2fc0ad0f34db661cbdfa72

format: reformat with latest openbmc-build-scripts

Reformat the repository using the latest from openbmc-build-scripts.
Add the `static/redfish` directory to be ignored by prettier since
these files

format: reformat with latest openbmc-build-scripts

Reformat the repository using the latest from openbmc-build-scripts.
Add the `static/redfish` directory to be ignored by prettier since
these files come from elsewhere and having the ability to do a direct
diff is handy.

Signed-off-by: Patrick Williams <patrick@stwcx.xyz>
Change-Id: I74464d6f97047b4888a591e0d8a4f5ca970ac69e

show more ...

Remove clang-tidy documentation

clang-tidy is now integrated into CI; Documenting the "manual" process
for running tidy doesn't provide value these days. Point to
openbmc-build-scripts as the "rec

Remove clang-tidy documentation

clang-tidy is now integrated into CI; Documenting the "manual" process
for running tidy doesn't provide value these days. Point to
openbmc-build-scripts as the "recommended" mechanism to run static
analysis.

Tested: Documentation only

Signed-off-by: Ed Tanous <edtanous@google.com>
Change-Id: Idac0d29e8976a168355bfa3b863b8600db916f14

show more ...

Document expectations for commit messages

This commit tries to be more explicit about the expectations for commit
messages and testing within bmcweb, and give maintainers something to
point to inste

Document expectations for commit messages

This commit tries to be more explicit about the expectations for commit
messages and testing within bmcweb, and give maintainers something to
point to instead of repeating the same statements over and over again.

This will likely need to evolve, but I think it's a good start, and
would help people put together commits that can be merged on the first
try, rather than requiring followup.

Tested: Documentation only, no testing.

Signed-off-by: Ed Tanous <edtanous@google.com>
Change-Id: Ib60ac90eccdc4f2c3215a755bbb462fff4796dd4

show more ...

doc: add a testing doc as guidelines for commits

Context:
https://gerrit.openbmc-project.xyz/c/openbmc/bmcweb/+/50742 is a small
but important change that changes how http_connection works. Maintain

doc: add a testing doc as guidelines for commits

Context:
https://gerrit.openbmc-project.xyz/c/openbmc/bmcweb/+/50742 is a small
but important change that changes how http_connection works. Maintainers
recommends doing a more complete testing for this type of change. I
found that having some docs as reference when performing testing is
helpful for every contributor.

Add a document for different types of testing we want contributors to
perform and include results in their commit messages. This doc will
evolve.

Also moved relevant sections in existing docs into this doc.

Signed-off-by: Nan Zhou <nanzhoumails@gmail.com>
Change-Id: Ia0b35950540ec6efaa813516d0e545c4b8f7c609

show more ...

Update clone and compile instructions

Signed-off-by: Chris Cain <cjcain@us.ibm.com>
Change-Id: I3c32cd0f0da2f930c309619732cfba0084bc8f94

Document Redfish OEM resource policy

We've had some unwritten guidelines around OEM resources in the past.
This commit aims to document them in a way that we can be fair to all
contributors, and mak

Document Redfish OEM resource policy

We've had some unwritten guidelines around OEM resources in the past.
This commit aims to document them in a way that we can be fair to all
contributors, and make clear the guidelines surrounding OEM schemas.

Signed-off-by: Ed Tanous <edtanous@google.com>
Change-Id: I0600373f3e0d72d18d1e4c002ed6594e25c4d323

show more ...

Fix naming conventions

Lots of code has been checked in that doesn't match the naming
conventions. Lets fix that.

Tested:
Code compiles. Variable/function renames only.

Signed-off-by: Ed Tanous

Fix naming conventions

Lots of code has been checked in that doesn't match the naming
conventions. Lets fix that.

Tested:
Code compiles. Variable/function renames only.

Signed-off-by: Ed Tanous <ed@tanous.net>
Change-Id: I6bd107811d0b724f1fad990016113cdf035b604b

show more ...

Add reoccuring errors doc

There are a number of common coding, design, and implementation mistakes
that bmcweb users tend to make. This attempts to document them so we
have a single source to point

Add reoccuring errors doc

There are a number of common coding, design, and implementation mistakes
that bmcweb users tend to make. This attempts to document them so we
have a single source to point users to when making gerrit comments. The
hope is that this alleviates some of the early mistakes that new users
tend to make.

Tested:
Documentation only. No functional changes.

Signed-off-by: Ed Tanous <ed@tanous.net>
Change-Id: Icc0081c94403c937d9a1ce44b7d6e81a5716a32e

show more ...

Codespell spelling fixes

These spelling errors were found using
https://github.com/codespell-project/codespell

Tested: Built and ran against validator.
Signed-off-by: Gunnar Mills <gmills@us.ibm.co

Codespell spelling fixes

These spelling errors were found using
https://github.com/codespell-project/codespell

Tested: Built and ran against validator.
Signed-off-by: Gunnar Mills <gmills@us.ibm.com>
Change-Id: I214fe102550295578cfdf0fc58305897d261ce55

show more ...

DEVELOPING: Engage Redfish before adding OEM

Added a Redfish section about engaging the DMTF's Redfish working group
before adding a Redfish OEM schema or property.

See https://lists.ozlabs.org/pip

DEVELOPING: Engage Redfish before adding OEM

Added a Redfish section about engaging the DMTF's Redfish working group
before adding a Redfish OEM schema or property.

See https://lists.ozlabs.org/pipermail/openbmc/2019-November/019571.html

Tested: https://jbt.github.io/markdown-editor/ and grammarly.com
Change-Id: I946483a90e34f63930a2cba047d14226d2da7583
Signed-off-by: Gunnar Mills <gmills@us.ibm.com>

show more ...

README: Added Redfish Service Validator testing

In the Redfish.md, we state "The redfish implementation shall pass
the Redfish Service Validator with no warnings or errors".

Added testing the Redfi

README: Added Redfish Service Validator testing

In the Redfish.md, we state "The redfish implementation shall pass
the Redfish Service Validator with no warnings or errors".

Added testing the Redfish Service Validator as part of the
"Developing and Testing" in DEVELOPING.md.

Change-Id: I1688d6a33066d74ca9d6a79d6241e8cc9fe9deb8
Signed-off-by: Gunnar Mills <gmills@us.ibm.com>

show more ...

Document commands to run clang-tidy

clang-tidy is a useful tool for automatically finding bad coding
patterns. Add documentation for how to run it manually.

Tested:
Docs change. Ran commands and

Document commands to run clang-tidy

clang-tidy is a useful tool for automatically finding bad coding
patterns. Add documentation for how to run it manually.

Tested:
Docs change. Ran commands and verified that clang-tidy runs.

Signed-off-by: Ed Tanous <ed.tanous@intel.com>
Change-Id: Ibff23be17af9042c2c5d9769c5d5570e5bbe7e3e

show more ...

redfish-doc: Move Redfish doc to its own file

Redfish support has been growing exponentially within bmcweb. Lets get a
separate document for it all.

Change-Id: Ibe895c7ab4bf4d2e1d51fce7136c0a6f8ca4

redfish-doc: Move Redfish doc to its own file

Redfish support has been growing exponentially within bmcweb. Lets get a
separate document for it all.

Change-Id: Ibe895c7ab4bf4d2e1d51fce7136c0a6f8ca4119d
Signed-off-by: Andrew Geissler <geissonator@yahoo.com>

show more ...

Revert "bmcweb: update SSL cipher suites to OWASP compatB"

This reverts commit 54fd221a9139f46c7c95b4a22cc09e6e7ce4cbbc.

Reason for revert: This breaks compatibility with python automation running

Revert "bmcweb: update SSL cipher suites to OWASP compatB"

This reverts commit 54fd221a9139f46c7c95b4a22cc09e6e7ce4cbbc.

Reason for revert: This breaks compatibility with python automation running on ubuntu 16.04, and regresses our ability to run the test harness. Suspect we need to run compat C by default, but lets revert for now to stabilize.

Change-Id: I4a01450836d917cd9558bc826c1877e629280850

show more ...

bmcweb: update SSL cipher suites to OWASP compatB

Previously, bmcweb was utilitizing the "mozilla compatibility" cipher
suites. This is overly lenient on broken ciphers and can cause some
issues wi

bmcweb: update SSL cipher suites to OWASP compatB

Previously, bmcweb was utilitizing the "mozilla compatibility" cipher
suites. This is overly lenient on broken ciphers and can cause some
issues with security reviews. In researching this, it looks like we
never actually documented that we follow Mozilla ciphers, aside from the
statement "The OpenBMC webserver shall follow the latest OWASP recommendations for
authentication, session management, and security." Considering that
we're moving _to_ OWASP recommendations, this commit is simply making us
follow the advice we already document, although this commit also updates
the documentation to be more clear.

Tested By:
Loaded on a BMC, opened web page in browser, and observed phosphor-webui
loaded correctly.

Change-Id: I912b35d378ce955c1472b2d54f1a365f6efea160
Signed-off-by: Ed Tanous <ed.tanous@intel.com>

show more ...

Add redfish schema link

Another thing I point people to a lot as a starting point
for their redfish work

Change-Id: I679dc12287bfa7d12f6e791ef0f31b1480d8190a
Signed-off-by: Andrew Geissler <geisson

Add redfish schema link

Another thing I point people to a lot as a starting point
for their redfish work

Change-Id: I679dc12287bfa7d12f6e791ef0f31b1480d8190a
Signed-off-by: Andrew Geissler <geissonator@yahoo.com>

show more ...

Add dev section on using SDK/QEMU

More and more developers are starting to work with bmcweb and I keep
repeating a lot of the same information to them. Figured getting it down
in this doc would help

Add dev section on using SDK/QEMU

More and more developers are starting to work with bmcweb and I keep
repeating a lot of the same information to them. Figured getting it down
in this doc would help others get up and going.

Change-Id: I536d0319cc278662f633761b1c38fe5820690a25
Signed-off-by: Andrew Geissler <geissonator@yahoo.com>

show more ...