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>

Carson Labrado authored Oct 13, 2022 and Ed Tanous committed Mar 01, 2023

Adds documentation on Redfish aggregation.  Includes an overview of its
current capabilities as well as how to enable and use the feature.

Signed-off-by: Carson Labrado <clabrado@google.com>
Change-Id: Ife8dae921e2d9772e7676dc927b41f7dfc00c047

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

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

Ed Tanous authored Jun 13, 2022 and Ed Tanous committed Jul 18, 2022

Many things in the readme were out of date, old, overly documented, or
downright wrong.  This commit attempts to update all the things that
need updated.  If any of them are controversial, I'm happy to break down
this patch more, but I suspect most of these should be reasonably
correct.

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

Josh Lehan authored Mar 16, 2022 and Ed Tanous committed Mar 17, 2022

They must run as two separate steps, otherwise the coverage process will
run before the test process completes, resulting in corrupted output.

Tested: Now it works for me.

Signed-off-by: Josh Lehan <krellan@google.com>
Change-Id: I164f0d67f0f350b9007db782ce33a17170ccd418

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

Manojkiran Eda authored May 27, 2020 and Ed Tanous committed Oct 02, 2020

- This commit enables the support for meson build system for
  bmcweb and also remove the cmake support

- The inital thought of migrating to meson build system was based
  on [link](https://mesonbuild.com/Simple-comparison.html)

- Other things to praise about meson are its simplicity and userfriendly ness.
  It also have native support for modern tools such as precompiled headers,
  coverage, Valgrind , unity builds e.t.c

- This commit also support the automatic download and setup of dependencies
  if they are not found in usual places using meson wraps that are already
  available in [wrap db](https://wrapdb.mesonbuild.com/)

- For few dependencies like boost, boost-url which does not have meson
  wrap support yet, i have misused the meson subproject command to download
  boost & boot-url and build against them if they are not found in usual
  places.

- For boost & boost-url the subproject command will always fail as meson
  supports other meson projects as subprojects but it will always download
  the source, and since we dont actually build boost/boost-url but just use
  the the source headers this should not be a problem.

- Cmake options removed:

   - BUILD_STATIC_LIBS has been removed as it is not being used any where as per the
     review comments.

-  By default the meson wraps are enabled and it downloads the dependencies if they
   are not found, and via bitbake this behaviour is disabled by default as download
   fallback feature is disabled.

- This commit also adds the README, changes for bmcweb as well.

- The meta-* layer changes are also pushed and marked as WIP under bmcweb_meson_port
  topic.

Tested By :
===========
1. Compilation is passed without error or warning in both arm & x86 sdks that
   are populated by yocto.
2. The unittests are also passed on both x86 & arm machines.
3. Compilation passed with various build types supported by meson (debug,debugoptimized,
   relase)
4. modified the meta-phosphor & meta-ibm to leverage meson build for bmcweb, and loaded
   the resulted image on qemu & real machine, checked the bmcweb status and was also able
   to pull the web-gui on both.
5. Tested few common commands related to session service & network service manually on a
   real machine and also also had run a CT regression bucket, and it looked clean.

The binary sizes when bmcweb is compiled via bitbake(using meta-ibm) are :
cmake: 3100080 bytes approx (3 MB)
meson: 2822596 bytes approx (2.7 MB)

1:1 equivalent hash is not possible due to couple of things:
1. The build types in meson does not have a 1:1 mapping with cmake build types.
2. Meson adds below mentioned compiler & linker flags than cmake as a part of
   warning_level & build types

CXXFLAGS :' -O2 -pipe -g -feliminate-unused-debug-types -fdiagnostics-color=always
            -D_FILE_OFFSET_BITS=64 -Winvalid-pch -DNDEBUG'
LDFLAGS : ' -Wl,-O1 -Wl,--hash-style=gnu -Wl,--as-needed -Wl,--no-undefined,-Wl,--end-group'

Tried to match the compile commands in both cmake & meson as much as possible and this
is what i could get.I have attached the compile_commands.json for both duing an yocto
full build in the [link](https://gofile.io/d/gM80fw

) for reference.

Signed-off-by: Manojkiran Eda <manojkiran.eda@gmail.com>
Change-Id: Ia65689fdacb8c398dd0a019258369b2442fad2f3

prime256v1 is okay for now, but secp384r1 is more future-proof (gives us
a couple more years) and in this case does not really have any
drawbacks.

Tested: Checked to see that a new secp384r1 key is generated on first
        boot and the generate CSR redfish option works.

Change-Id: I334fc56db3dd55058a4c6780f8966bcc48d8f816
Signed-off-by: Vernon Mauery <vernon.mauery@linux.intel.com>

Recently, a number of people in the community have made the (admittedly
easy) mistake that we use a significant portion of crow.

Today, we use crow for the router, and the "app" structure, and even
those have been significantly modified to meet the bmc needs.  All other
components have been replaced with Boost beast.  This commit removes the
crow mentions from the Readme, and moves the crow folder to "http" to
camouflage it a little.  No code content has changed.

Tested:
Code compiles.  No functional change made to any executable code.

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

A step towards upstream OpenBMC shipping free of any branding (other
than OpenBMC branding) or company references.

Tested: Did not test
Change-Id: I4fea765949ff3ad94e3cd52fedec597a77db0e79
Signed-off-by: Brad Bishop <bradleyb@fuzziesquirrel.com>
Signed-off-by: Gunnar Mills <gmills@us.ibm.com>

boost::asio::io_service is removed in leiu of io_context, which is a
closer match to the networking TS.  Move us to that implementatio.

This was an automated move using the following command:
git grep -l 'io_service' | xargs sed -i 's/io_service/io_context/g'

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

This adds details about how to control which BMCWeb features are
enabled at build time, and how persistent configuration data and
SSL certificates and handled.

Tested: N/A

Change-Id: Id0fc6617da859468e433f2038e9aaf4645c99ab0
Signed-off-by: Joseph Reynolds <jrey@us.ibm.com>

This patchset moves bmcweb over to the upstream style naming
conventions for variables, classes, and functions, as well as imposes
the latest clang-format file.

This changeset was mostly built automatically by the included
.clang-tidy file, which has the ability to autoformat and auto rename
variables.  At some point in the future I would like to see this in
greater use, but for now, we will impose it on bmcweb, and see how it
goes.

Tested: Code still compiles, and appears to run, although other issues
are possible and likely.

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

Change-Id: I6c42154a40417e6b36cd6e096e1fad465f4a3a84