cc-backend/internal/tagger/detectApp.go

// Copyright (C) NHR@FAU, University Erlangen-Nuremberg.
// All rights reserved. This file is part of cc-backend.
// Use of this source code is governed by a MIT-style
// license that can be found in the LICENSE file.

package tagger

import (
	"bufio"
	"fmt"
	"os"
	"path/filepath"
	"regexp"
	"strings"

	"github.com/ClusterCockpit/cc-backend/internal/repository"
	cclog "github.com/ClusterCockpit/cc-lib/v2/ccLogger"
	"github.com/ClusterCockpit/cc-lib/v2/schema"
	"github.com/ClusterCockpit/cc-lib/v2/util"
)

const (
	// defaultConfigPath is the default path for application tagging configuration
	defaultConfigPath = "./var/tagger/apps"
	// tagTypeApp is the tag type identifier for application tags
	tagTypeApp = "app"
	// configDirMatch is the directory name used for matching filesystem events
	configDirMatch = "apps"
)

type appInfo struct {
	tag     string
	strings []string
}

// AppTagger detects applications by matching patterns in job scripts.
// It loads application patterns from an external configuration directory and can dynamically reload
// configuration when files change. When a job script matches a pattern,
// the corresponding application tag is automatically applied.
type AppTagger struct {
	// apps maps application tags to their matching patterns
	apps map[string]appInfo
	// tagType is the type of tag ("app")
	tagType string
	// cfgPath is the path to watch for configuration changes
	cfgPath string
}

func (t *AppTagger) scanApp(f *os.File, fns string) {
	scanner := bufio.NewScanner(f)
	ai := appInfo{tag: strings.TrimSuffix(fns, filepath.Ext(fns)), strings: make([]string, 0)}

	for scanner.Scan() {
		ai.strings = append(ai.strings, scanner.Text())
	}
	delete(t.apps, ai.tag)
	t.apps[ai.tag] = ai
}

// EventMatch checks if a filesystem event should trigger configuration reload.
// It returns true if the event path contains "apps".
func (t *AppTagger) EventMatch(s string) bool {
	return strings.Contains(s, configDirMatch)
}

// EventCallback is triggered when the configuration directory changes.
// It reloads all application pattern files from the watched directory.
// FIXME: Only process the file that caused the event
func (t *AppTagger) EventCallback() {
	files, err := os.ReadDir(t.cfgPath)
	if err != nil {
		cclog.Fatal(err)
	}

	for _, fn := range files {
		fns := fn.Name()
		cclog.Debugf("Process: %s", fns)
		f, err := os.Open(filepath.Join(t.cfgPath, fns))
		if err != nil {
			cclog.Errorf("error opening app file %s: %#v", fns, err)
			continue
		}
		t.scanApp(f, fns)
		f.Close()
	}
}

// Register initializes the AppTagger by loading application patterns from external folder.
// It sets up a file watch on ./var/tagger/apps if it exists, allowing for
// dynamic configuration updates without restarting the application.
// Returns an error if the configuration path does not exist or cannot be read.
func (t *AppTagger) Register() error {
	if t.cfgPath == "" {
		t.cfgPath = defaultConfigPath
	}
	t.tagType = tagTypeApp
	t.apps = make(map[string]appInfo, 0)

	if !util.CheckFileExists(t.cfgPath) {
		return fmt.Errorf("configuration path does not exist: %s", t.cfgPath)
	}

	files, err := os.ReadDir(t.cfgPath)
	if err != nil {
		return fmt.Errorf("error reading app folder: %#v", err)
	}

	for _, fn := range files {
		fns := fn.Name()
		cclog.Debugf("Process: %s", fns)
		f, err := os.Open(filepath.Join(t.cfgPath, fns))
		if err != nil {
			cclog.Errorf("error opening app file %s: %#v", fns, err)
			continue
		}
		t.scanApp(f, fns)
		f.Close()
	}

	cclog.Infof("Setup file watch for %s", t.cfgPath)
	util.AddListener(t.cfgPath, t)

	return nil
}

// Match attempts to detect the application used by a job by analyzing its job script.
// It fetches the job metadata, extracts the job script, and matches it against
// all configured application patterns using regular expressions.
// If a match is found, the corresponding application tag is added to the job.
// Only the first matching application is tagged.
func (t *AppTagger) Match(job *schema.Job) {
	r := repository.GetJobRepository()
	metadata, err := r.FetchMetadata(job)
	if err != nil {
		cclog.Infof("Cannot fetch metadata for job: %d on %s", job.JobID, job.Cluster)
		return
	}

	jobscript, ok := metadata["jobScript"]
	if ok {
		id := *job.ID

	out:
		for _, a := range t.apps {
			tag := a.tag
			for _, s := range a.strings {
				matched, _ := regexp.MatchString(s, strings.ToLower(jobscript))
				if matched {
					if !r.HasTag(id, t.tagType, tag) {
						r.AddTagOrCreateDirect(id, t.tagType, tag)
						break out
					}
				}
			}
		}
	} else {
		cclog.Infof("Cannot extract job script for job: %d on %s", job.JobID, job.Cluster)
	}
}