github.com/drone/go-convert@v0.0.0-20240307072510-6bd371c65e61/convert/travis/yaml/parse.go (about)

     1  // Copyright 2022 Harness, Inc.
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //      http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  
    15  package yaml
    16  
    17  import (
    18  	"bytes"
    19  	"io"
    20  	"os"
    21  
    22  	"gopkg.in/yaml.v3"
    23  )
    24  
    25  // Parse parses the configuration from io.Reader r.
    26  func Parse(r io.Reader) (*Pipeline, error) {
    27  	out := new(Pipeline)
    28  	dec := yaml.NewDecoder(r)
    29  	err := dec.Decode(out)
    30  	return out, err
    31  }
    32  
    33  // ParseBytes parses the configuration from bytes b.
    34  func ParseBytes(b []byte) (*Pipeline, error) {
    35  	return Parse(
    36  		bytes.NewBuffer(b),
    37  	)
    38  }
    39  
    40  // ParseString parses the configuration from string s.
    41  func ParseString(s string) (*Pipeline, error) {
    42  	return ParseBytes(
    43  		[]byte(s),
    44  	)
    45  }
    46  
    47  // ParseFile parses the configuration from path p.
    48  func ParseFile(p string) (*Pipeline, error) {
    49  	f, err := os.Open(p)
    50  	if err != nil {
    51  		return nil, err
    52  	}
    53  	defer f.Close()
    54  	return Parse(f)
    55  }