refactor(bbb-config): More robust updates of recordings' "metadata.xml" when issuing "bbb-conf --setip" #12682
Conversation
|
This pull request has conflicts ☹ |
steffen-moser
changed the title
|
SonarCloud Quality Gate failed.
|
|
Unfortunately, I cannot see what kind of code smells SonarCloud has detected – otherwise I would have been fixing it already. O.K., there is still some redundancy left (which probably could have been resolved by using another loop around the "xmlstarlet" calls). Nevertheless, when comparing to the former version of the code (containing a lot of "sed" commands), it should have reduced possible redundancies a lot. |
antobinary
changed the title
|
Tested in production with 2.3 and working. @antobinary Can we please port back this PR to 2.3.x? Very hand when moving the recordings from the server to another. |
What does this PR do?
"bbb-conf --setip " updates a lot of configuration files. Among other things, it also updates the "metadata.xml" files of recordings in order to have URLs pointing to the new hostname. The primarily used "sed" commands did not touch URLs when linebreaks have been between the opening XML tags and the URLs themselves or when the XML attributes are in a different order.
The PR should fix this by using "xmlstarlet" which has been already used by "bbb-conf" for other changes/updates.
Closes Issue(s)
Closes #12628
Motivation
Altering XML files with a line-based stream editor (like "sed") is not a good idea in general. It is always prone to exceptions to the pattern a programmer has in mind. Especially, the XML files for rather old recordings might have been generated by scripts that have been exchanged for years. Nobody thinks about them. Therefore, we need a robust mechanism to update the URLs. Of course, "sed" could be tweaked to parse patterns across multiple lines, but it still remains a fragile construct, e.g., when the format of "metadata.xml" might be updated in th future.