github.com/olitvin/migrate/v4@v4.14.3-0.20210330111251-992b37ee04c8/source/github/github.go (about)

     1  package github
     2  
     3  import (
     4  	"context"
     5  	"fmt"
     6  	"io"
     7  	"io/ioutil"
     8  	"net/http"
     9  	nurl "net/url"
    10  	"os"
    11  	"path"
    12  	"strings"
    13  )
    14  
    15  import (
    16  	"github.com/google/go-github/github"
    17  	"github.com/olitvin/migrate/v4/source"
    18  )
    19  
    20  func init() {
    21  	source.Register("github", &Github{})
    22  }
    23  
    24  var (
    25  	ErrNoUserInfo          = fmt.Errorf("no username:token provided")
    26  	ErrNoAccessToken       = fmt.Errorf("no access token")
    27  	ErrInvalidRepo         = fmt.Errorf("invalid repo")
    28  	ErrInvalidGithubClient = fmt.Errorf("expected *github.Client")
    29  	ErrNoDir               = fmt.Errorf("no directory")
    30  )
    31  
    32  type Github struct {
    33  	config     *Config
    34  	client     *github.Client
    35  	options    *github.RepositoryContentGetOptions
    36  	migrations *source.Migrations
    37  }
    38  
    39  type Config struct {
    40  	Owner string
    41  	Repo  string
    42  	Path  string
    43  	Ref   string
    44  }
    45  
    46  func (g *Github) Open(url string) (source.Driver, error) {
    47  	u, err := nurl.Parse(url)
    48  	if err != nil {
    49  		return nil, err
    50  	}
    51  
    52  	// client defaults to http.DefaultClient
    53  	var client *http.Client
    54  	if u.User != nil {
    55  		password, ok := u.User.Password()
    56  		if !ok {
    57  			return nil, ErrNoUserInfo
    58  		}
    59  
    60  		tr := &github.BasicAuthTransport{
    61  			Username: u.User.Username(),
    62  			Password: password,
    63  		}
    64  		client = tr.Client()
    65  	}
    66  
    67  	gn := &Github{
    68  		client:     github.NewClient(client),
    69  		migrations: source.NewMigrations(),
    70  		options:    &github.RepositoryContentGetOptions{Ref: u.Fragment},
    71  	}
    72  
    73  	gn.ensureFields()
    74  
    75  	// set owner, repo and path in repo
    76  	gn.config.Owner = u.Host
    77  	pe := strings.Split(strings.Trim(u.Path, "/"), "/")
    78  	if len(pe) < 1 {
    79  		return nil, ErrInvalidRepo
    80  	}
    81  	gn.config.Repo = pe[0]
    82  	if len(pe) > 1 {
    83  		gn.config.Path = strings.Join(pe[1:], "/")
    84  	}
    85  
    86  	if err := gn.readDirectory(); err != nil {
    87  		return nil, err
    88  	}
    89  
    90  	return gn, nil
    91  }
    92  
    93  func WithInstance(client *github.Client, config *Config) (source.Driver, error) {
    94  	gn := &Github{
    95  		client:     client,
    96  		config:     config,
    97  		migrations: source.NewMigrations(),
    98  		options:    &github.RepositoryContentGetOptions{Ref: config.Ref},
    99  	}
   100  
   101  	if err := gn.readDirectory(); err != nil {
   102  		return nil, err
   103  	}
   104  
   105  	return gn, nil
   106  }
   107  
   108  func (g *Github) readDirectory() error {
   109  	g.ensureFields()
   110  
   111  	fileContent, dirContents, _, err := g.client.Repositories.GetContents(
   112  		context.Background(),
   113  		g.config.Owner,
   114  		g.config.Repo,
   115  		g.config.Path,
   116  		g.options,
   117  	)
   118  
   119  	if err != nil {
   120  		return err
   121  	}
   122  	if fileContent != nil {
   123  		return ErrNoDir
   124  	}
   125  
   126  	for _, fi := range dirContents {
   127  		m, err := source.DefaultParse(*fi.Name)
   128  		if err != nil {
   129  			continue // ignore files that we can't parse
   130  		}
   131  		if !g.migrations.Append(m) {
   132  			return fmt.Errorf("unable to parse file %v", *fi.Name)
   133  		}
   134  	}
   135  
   136  	return nil
   137  }
   138  
   139  func (g *Github) ensureFields() {
   140  	if g.config == nil {
   141  		g.config = &Config{}
   142  	}
   143  }
   144  
   145  func (g *Github) Close() error {
   146  	return nil
   147  }
   148  
   149  func (g *Github) First() (version uint, err error) {
   150  	g.ensureFields()
   151  
   152  	if v, ok := g.migrations.First(); !ok {
   153  		return 0, &os.PathError{Op: "first", Path: g.config.Path, Err: os.ErrNotExist}
   154  	} else {
   155  		return v, nil
   156  	}
   157  }
   158  
   159  func (g *Github) Prev(version uint) (prevVersion uint, err error) {
   160  	g.ensureFields()
   161  
   162  	if v, ok := g.migrations.Prev(version); !ok {
   163  		return 0, &os.PathError{Op: fmt.Sprintf("prev for version %v", version), Path: g.config.Path, Err: os.ErrNotExist}
   164  	} else {
   165  		return v, nil
   166  	}
   167  }
   168  
   169  func (g *Github) Next(version uint) (nextVersion uint, err error) {
   170  	g.ensureFields()
   171  
   172  	if v, ok := g.migrations.Next(version); !ok {
   173  		return 0, &os.PathError{Op: fmt.Sprintf("next for version %v", version), Path: g.config.Path, Err: os.ErrNotExist}
   174  	} else {
   175  		return v, nil
   176  	}
   177  }
   178  
   179  func (g *Github) ReadUp(version uint) (r io.ReadCloser, identifier string, err error) {
   180  	g.ensureFields()
   181  
   182  	if m, ok := g.migrations.Up(version); ok {
   183  		file, _, _, err := g.client.Repositories.GetContents(
   184  			context.Background(),
   185  			g.config.Owner,
   186  			g.config.Repo,
   187  			path.Join(g.config.Path, m.Raw),
   188  			g.options,
   189  		)
   190  
   191  		if err != nil {
   192  			return nil, "", err
   193  		}
   194  		if file != nil {
   195  			r, err := file.GetContent()
   196  			if err != nil {
   197  				return nil, "", err
   198  			}
   199  			return ioutil.NopCloser(strings.NewReader(r)), m.Identifier, nil
   200  		}
   201  	}
   202  	return nil, "", &os.PathError{Op: fmt.Sprintf("read version %v", version), Path: g.config.Path, Err: os.ErrNotExist}
   203  }
   204  
   205  func (g *Github) ReadDown(version uint) (r io.ReadCloser, identifier string, err error) {
   206  	g.ensureFields()
   207  
   208  	if m, ok := g.migrations.Down(version); ok {
   209  		file, _, _, err := g.client.Repositories.GetContents(
   210  			context.Background(),
   211  			g.config.Owner,
   212  			g.config.Repo,
   213  			path.Join(g.config.Path, m.Raw),
   214  			g.options,
   215  		)
   216  
   217  		if err != nil {
   218  			return nil, "", err
   219  		}
   220  		if file != nil {
   221  			r, err := file.GetContent()
   222  			if err != nil {
   223  				return nil, "", err
   224  			}
   225  			return ioutil.NopCloser(strings.NewReader(r)), m.Identifier, nil
   226  		}
   227  	}
   228  	return nil, "", &os.PathError{Op: fmt.Sprintf("read version %v", version), Path: g.config.Path, Err: os.ErrNotExist}
   229  }