Merge pull request 'deploy rocky branding' (#2) from tcooper/ansible-openqa-management:add_branding into main

Reviewed-on: infrastructure/ansible-openqa-management#2

files/usr/share/openqa/assets/assetpack.def.patch

@@ -0,0 +1,15 @@
+--- assetpack.def.orig	2023-01-24 03:37:58.521562449 +0000
++++ assetpack.def	2023-01-24 03:38:14.488517673 +0000
+@@ -246,6 +246,12 @@
+ ! terminal.svg
+ < images/terminal.svg
+ 
++! rocky.png
++< images/rocky.png
++
++! rocky.svg
++< images/rocky.svg
++
+ ! suse.png
+ < images/suse.png
+ 

files/usr/share/openqa/assets/images/rocky.svg

@@ -0,0 +1,12 @@
+<svg width="1101" height="193" viewBox="0 0 1101 193" fill="none" xmlns="http://www.w3.org/2000/svg">
+<g clip-path="url(#clip0_1_30)">
+<path fill-rule="evenodd" clip-rule="evenodd" d="M186.658 128.658C190.119 118.746 192 108.093 192 97C192 43.9807 149.019 1 96 1C42.9807 1 0 43.9807 0 97C0 123.234 10.523 147.011 27.5783 164.338L124.958 66.9584L149 91L186.658 128.658ZM169.122 159.205L124.958 115.042L55.7978 184.202C68.0269 189.849 81.6455 193 96 193C125.288 193 151.514 179.884 169.122 159.205Z" fill="#10B981"/>
+<path d="M251.072 147V46.2H300.32C305.408 46.2 310.064 46.968 314.288 48.504C318.608 50.04 322.304 52.2 325.376 54.984C328.448 57.672 330.848 60.936 332.576 64.776C334.304 68.616 335.168 72.84 335.168 77.448C335.168 83.784 333.344 89.448 329.696 94.44C326.144 99.432 321.392 103.128 315.44 105.528L337.76 147H314.432L294.704 108.408H271.952V147H251.072ZM298.448 64.2H271.952V91.272H298.448C303.152 91.272 306.896 90.024 309.68 87.528C312.56 85.032 314 81.768 314 77.736C314 73.704 312.56 70.44 309.68 67.944C306.896 65.448 303.152 64.2 298.448 64.2ZM339.695 109.56C339.695 104.088 340.703 99 342.719 94.296C344.831 89.496 347.663 85.368 351.215 81.912C354.863 78.36 359.135 75.576 364.031 73.56C368.927 71.544 374.159 70.536 379.727 70.536C385.295 70.536 390.527 71.544 395.423 73.56C400.319 75.576 404.543 78.36 408.095 81.912C411.743 85.368 414.575 89.496 416.591 94.296C418.703 99 419.759 104.088 419.759 109.56C419.759 115.032 418.703 120.168 416.591 124.968C414.575 129.672 411.743 133.752 408.095 137.208C404.543 140.664 400.319 143.4 395.423 145.416C390.527 147.432 385.295 148.44 379.727 148.44C374.159 148.44 368.927 147.432 364.031 145.416C359.135 143.4 354.863 140.664 351.215 137.208C347.663 133.752 344.831 129.672 342.719 124.968C340.703 120.168 339.695 115.032 339.695 109.56ZM379.727 131.304C385.487 131.304 390.383 129.192 394.415 124.968C398.447 120.744 400.463 115.608 400.463 109.56C400.463 103.416 398.447 98.232 394.415 94.008C390.383 89.784 385.487 87.672 379.727 87.672C373.967 87.672 369.071 89.784 365.039 94.008C361.007 98.232 358.991 103.416 358.991 109.56C358.991 115.608 361.007 120.744 365.039 124.968C369.071 129.192 373.967 131.304 379.727 131.304ZM469.168 131.16C472.528 131.16 475.648 130.488 478.528 129.144C481.504 127.8 484.336 125.688 487.024 122.808L498.832 135.048C494.992 139.272 490.384 142.584 485.008 144.984C479.632 147.288 474.064 148.44 468.304 148.44C462.832 148.44 457.648 147.432 452.752 145.416C447.952 143.4 443.776 140.664 440.224 137.208C436.768 133.752 434.032 129.672 432.016 124.968C430 120.168 428.992 115.032 428.992 109.56C428.992 104.088 430 99 432.016 94.296C434.032 89.496 436.768 85.368 440.224 81.912C443.776 78.36 447.952 75.576 452.752 73.56C457.648 71.544 462.832 70.536 468.304 70.536C474.256 70.536 479.968 71.736 485.44 74.136C490.912 76.44 495.568 79.704 499.408 83.928L487.312 96.744C484.624 93.768 481.744 91.512 478.672 89.976C475.6 88.44 472.288 87.672 468.736 87.672C463.072 87.672 458.272 89.784 454.336 94.008C450.496 98.232 448.576 103.416 448.576 109.56C448.576 115.704 450.544 120.84 454.48 124.968C458.512 129.096 463.408 131.16 469.168 131.16ZM509.089 147V46.2L528.817 41.88V103.656L561.217 71.976H583.537L548.401 106.392L585.697 147H560.497L528.817 112.728V147H509.089ZM612.643 150.456L613.795 147.72L584.562 71.976H606.307L624.883 123.096L646.195 71.976H667.507L632.947 152.904C629.107 161.928 624.643 168.36 619.555 172.2C614.467 176.04 607.843 177.96 599.683 177.96C597.955 177.96 596.275 177.864 594.643 177.672C593.107 177.576 591.859 177.384 590.899 177.096V160.104C591.859 160.296 592.867 160.44 593.923 160.536C594.979 160.632 596.275 160.68 597.811 160.68C601.363 160.68 604.339 159.816 606.739 158.088C609.235 156.36 611.203 153.816 612.643 150.456ZM706.744 147V46.2H717.832V137.064H777.88V147H706.744ZM796.963 61.032C795.043 61.032 793.363 60.312 791.923 58.872C790.483 57.432 789.763 55.752 789.763 53.832C789.763 51.816 790.483 50.136 791.923 48.792C793.363 47.352 795.043 46.632 796.963 46.632C798.979 46.632 800.659 47.352 802.003 48.792C803.443 50.136 804.163 51.816 804.163 53.832C804.163 55.752 803.443 57.432 802.003 58.872C800.659 60.312 798.979 61.032 796.963 61.032ZM802.291 74.856V147H791.635V74.856H802.291ZM820.463 147V74.856H831.119V83.352C833.903 80.088 837.215 77.64 841.055 76.008C844.895 74.28 849.167 73.416 853.871 73.416C862.031 73.416 868.703 76.008 873.887 81.192C879.071 86.376 881.663 93.096 881.663 101.352V147H871.151V103.512C871.151 97.176 869.327 92.136 865.679 88.392C862.031 84.648 857.135 82.776 850.991 82.776C846.671 82.776 842.783 83.736 839.327 85.656C835.967 87.576 833.231 90.312 831.119 93.864V147H820.463ZM909.015 74.856V118.344C909.015 124.68 910.839 129.72 914.487 133.464C918.135 137.208 923.031 139.08 929.175 139.08C933.495 139.08 937.335 138.12 940.695 136.2C944.151 134.184 946.935 131.4 949.047 127.848V74.856H959.703V147H949.047V138.648C946.263 141.912 942.951 144.36 939.111 145.992C935.367 147.624 931.143 148.44 926.439 148.44C918.183 148.44 911.463 145.848 906.279 140.664C901.095 135.48 898.503 128.76 898.503 120.504V74.856H909.015ZM969.47 147L997.838 109.848L970.91 74.856H983.582L1004.03 101.928L1024.48 74.856H1036.72L1010.08 109.704L1038.59 147H1025.92L1003.89 117.624L981.566 147H969.47Z" fill="black"/>
+<path d="M1048 70.624V54.976H1042.82V51.952H1048V45.856L1051.5 44.944V51.952H1058.75V54.976H1051.5V69.712C1051.5 70.992 1051.79 71.92 1052.37 72.496C1052.94 73.04 1053.89 73.312 1055.2 73.312C1055.87 73.312 1056.46 73.264 1056.98 73.168C1057.52 73.072 1058.1 72.912 1058.7 72.688V75.808C1058.1 76.032 1057.41 76.192 1056.64 76.288C1055.9 76.384 1055.18 76.432 1054.48 76.432C1052.4 76.432 1050.8 75.936 1049.68 74.944C1048.56 73.952 1048 72.512 1048 70.624ZM1062.56 76V51.952H1066.11V54.592C1067 53.568 1068.04 52.8 1069.23 52.288C1070.41 51.744 1071.72 51.472 1073.16 51.472C1074.83 51.472 1076.32 51.872 1077.63 52.672C1078.97 53.44 1080.01 54.496 1080.75 55.84C1081.74 54.368 1082.92 53.28 1084.3 52.576C1085.71 51.84 1087.28 51.472 1089 51.472C1091.6 51.472 1093.71 52.336 1095.34 54.064C1097 55.792 1097.84 58.032 1097.84 60.784V76H1094.33V61.504C1094.33 59.392 1093.77 57.712 1092.65 56.464C1091.53 55.216 1090.01 54.592 1088.09 54.592C1086.78 54.592 1085.58 54.928 1084.49 55.6C1083.4 56.272 1082.48 57.248 1081.71 58.528C1081.77 58.88 1081.82 59.248 1081.85 59.632C1081.92 59.984 1081.95 60.368 1081.95 60.784V76H1078.44V61.504C1078.44 59.392 1077.88 57.712 1076.76 56.464C1075.64 55.216 1074.14 54.592 1072.25 54.592C1070.97 54.592 1069.8 54.896 1068.75 55.504C1067.72 56.08 1066.84 56.944 1066.11 58.096V76H1062.56Z" fill="black"/>
+</g>
+<defs>
+<clipPath id="clip0_1_30">
+<rect width="1101" height="193" fill="white"/>
+</clipPath>
+</defs>
+</svg>

files/usr/share/openqa/templates/webapi/branding/rocky/docbox.html.ep

@@ -0,0 +1 @@
+%=include 'branding/plain/docbox'

files/usr/share/openqa/templates/webapi/branding/rocky/sponsorbox.html.ep

@@ -0,0 +1,5 @@
+<div class="text-right" id="sponsorbox">
+    <a href="https://www.rockylinux.org" title="Rocky Linux">
+        <img alt="sponsor_rocky_linux" width="100%" src="<%= icon_url 'rocky.svg' %>" />
+    </a>
+</div>

files/usr/share/openqa/templates/webapi/main/index.html.ep.patch

@@ -0,0 +1,15 @@
+--- index.html.ep	2023-01-24 03:34:10.861205160 +0000
++++ index.html.ep	2023-01-24 03:34:44.364110582 +0000
+@@ -10,10 +10,10 @@
+ <div class="jumbotron">
+   <div class='container'>
+     <div class="row">
+-      <div class="col-md-9">
++      <div class="col-md-6">
+         %= include_branding 'docbox'
+       </div>
+-      <div class="col-md-3 hidden-sm-down">
++      <div class="col-md-6 hidden-sm-down">
+         %= include_branding 'sponsorbox'
+       </div>
+     </div>

init-rocky-openqa-developer-host.yml

@@ -20,6 +20,7 @@
   become: true
   vars_files:
     - vars/openqa.yml
+    - vars/openqa_branding.yml
 
   # This is to try to avoid the handler issue in pre/post tasks
   handlers:
@@ -41,6 +42,8 @@
   tasks:
     - name: Install and configure OpenQA
       import_tasks: tasks/openqa.yml
+    - name: Apply Rocky Linux OpenQA Branding
+      import_tasks: tasks/openqa_branding.yml
 
   post_tasks:
     - name: Touching run file that ansible has ran here

tasks/openqa_branding.yml

@@ -0,0 +1,35 @@
+---
+- name: Copy assets hierarchy
+  ansible.posix.synchronize:
+    src: "{{ assets_src_dir }}/"
+    dest: "{{ assets_dest_dir }}"
+    recursive: true
+  tags:
+    - branding
+
+- name: Copy templates hierarchy
+  ansible.posix.synchronize:
+    src: "{{ templates_src_dir }}/"
+    dest: "{{ templates_dest_dir }}"
+    recursive: true
+  tags:
+    - branding
+
+- name: Apply patches to specific assets, template and config files
+  ansible.posix.patch:
+    src: "{{ item.patch }}"
+    dest: "{{ item.path }}"
+    # optional parameters, see documentation for details
+    # strip: 1
+    backup: true
+  with_items: "{{ branding_patches }}"
+  tags:
+    - branding
+
+- name: Restart openqa-webui service
+  ansible.builtin.systemd:
+    name: openqa-webui
+    state: restarted
+  tags:
+    - branding
+...

templates/etc/openqa/openqa.ini.j2

@@ -1,5 +1,5 @@
 [global]
-branding=plain
+branding = {{ openqa_branding }}
 download_domains = rockylinux.org fedoraproject.org opensuse.org
 
 [auth]

vars/openqa_branding.yml

@@ -0,0 +1,14 @@
+---
+# Branding type used, default is plain but we are rocky
+openqa_branding: "rocky"
+
+assets_src_dir: "{{ playbook_dir }}/files/usr/share/openqa/assets"
+assets_dest_dir: "/usr/share/openqa/assets"
+
+templates_src_dir: "{{ playbook_dir }}/files/usr/share/openqa/templates"
+templates_dest_dir: "/usr/share/openqa/templates"
+
+branding_patches:
+  - { path: /usr/share/openqa/assets/assetpack.def, patch: /usr/share/openqa/assets/assetpack.def.patch }
+  - { path: /usr/share/openqa/templates/webapi/main/index.html.ep, patch: /usr/share/openqa/templates/webapi/main/index.html.ep.patch }
+...