/*
Copyright 2020 The Kubernetes Authors.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package html
import (
"bytes"
"encoding/json"
"fmt"
"path/filepath"
"text/template"
"github.com/sirupsen/logrus"
"k8s.io/test-infra/prow/config"
"k8s.io/test-infra/prow/spyglass/api"
"k8s.io/test-infra/prow/spyglass/lenses"
)
func init() {
lenses.RegisterLens(Lens{})
}
type Lens struct{}
// Config returns the lens's configuration.
func (lens Lens) Config() lenses.LensConfig {
return lenses.LensConfig{
Name: "html",
Title: "HTML",
Priority: 3,
HideTitle: true,
}
}
// Header renders the content of from template.html.
func (lens Lens) Header(artifacts []api.Artifact, resourceDir string, config json.RawMessage, spyglassConfig config.Spyglass) string {
t, err := template.ParseFiles(filepath.Join(resourceDir, "template.html"))
if err != nil {
return fmt.Sprintf("", err)
}
var buf bytes.Buffer
if err := t.ExecuteTemplate(&buf, "header", nil); err != nil {
return fmt.Sprintf("", err)
}
return buf.String()
}
// Callback does nothing.
func (lens Lens) Callback(artifacts []api.Artifact, resourceDir string, data string, config json.RawMessage, spyglassConfig config.Spyglass) string {
return ""
}
// Body renders the
func (lens Lens) Body(artifacts []api.Artifact, resourceDir string, data string, config json.RawMessage, spyglassConfig config.Spyglass) string {
if len(artifacts) == 0 {
logrus.Error("html Body() called with no artifacts, which should never happen.")
return "Why am I here? There is no html file"
}
documents := map[string]string{}
for _, artifact := range artifacts {
content, err := artifact.ReadAll()
if err != nil {
logrus.WithError(err).WithField("artifact_url", artifact.CanonicalLink()).Warn("failed to read content")
continue
}
name := filepath.Base(artifact.CanonicalLink())
content = injectHeightNotifier(content, name)
// Escape double quotes as we are going to put this into an iframes srcdoc attribute. We can not reference the
// src directly because we have to inject the height notifier.
// Ref: https://html.spec.whatwg.org/multipage/iframe-embed-object.html#attr-iframe-srcdoc
content = bytes.ReplaceAll(content, []byte(`"`), []byte(`"`))
documents[name] = string(content)
}
template, err := template.ParseFiles(filepath.Join(resourceDir, "template.html"))
if err != nil {
logrus.WithError(err).Error("Error executing template.")
return fmt.Sprintf("Failed to load template file: %v", err)
}
buf := &bytes.Buffer{}
if err := template.ExecuteTemplate(buf, "body", documents); err != nil {
return fmt.Sprintf("failed to execute template: %v", err)
}
return buf.String()
}
// injectHeightNotifier injects a small javascript snippet that will tell the iframe container about the height
// of the iframe. Iframe height can only be set as an absolute value and CORS doesn't allow the container to
// query the iframe.
func injectHeightNotifier(content []byte, name string) []byte {
content = append([]byte(``), content...)
// From https://stackoverflow.com/a/44547866 and extended to also pass
// back the element id, as we can have multiple pages.
return append(content, []byte(fmt.Sprintf(`
`, name))...)
}