java/com/google/gerrit/plugins/codeowners/backend/config/CodeOwnersProjectConfigFile.java

// Copyright (C) 2021 The Android Open Source Project
//
// 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 com.google.gerrit.plugins.codeowners.backend.config;

import static com.google.common.base.Preconditions.checkState;

import com.google.gerrit.entities.RefNames;
import com.google.gerrit.server.git.meta.VersionedMetaData;
import java.io.IOException;
import org.eclipse.jgit.errors.ConfigInvalidException;
import org.eclipse.jgit.lib.CommitBuilder;
import org.eclipse.jgit.lib.Config;

/**
 * Reads/writes the code-owners project configuration from/to the {@code code-owners.config} file in
 * the {@code refs/meta/config} branch.
 */
public class CodeOwnersProjectConfigFile extends VersionedMetaData {
  public static final String FILE_NAME = "code-owners.config";

  private boolean isLoaded = false;
  private Config config;

  @Override
  protected String getRefName() {
    return RefNames.REFS_CONFIG;
  }

  /**
   * Returns the loaded code owners config.
   *
   * <p>Fails if loading was not done yet.
   */
  public Config getConfig() {
    checkLoaded();
    return config;
  }

  @Override
  protected void onLoad() throws IOException, ConfigInvalidException {
    if (revision != null) {
      config = readConfig(FILE_NAME);
    } else {
      config = new Config();
    }
    isLoaded = true;
  }

  @Override
  protected boolean onSave(CommitBuilder commit) throws IOException, ConfigInvalidException {
    checkLoaded();
    saveConfig(FILE_NAME, config);
    return true;
  }

  private void checkLoaded() {
    checkState(isLoaded, "%s not loaded yet", FILE_NAME);
  }
}