This is an archive of the discontinued Mercurial Phabricator instance.

pushvars: cleanup the extension to just set the server config option
AbandonedPublic

Authored by pulkit on Aug 22 2017, 8:02 AM.

Download Raw Diff

Details

Reviewers

kulshrax
quark

Group Reviewers

Restricted Project

Summary

The --pushvars option to push is moved to core with an extra config named
push.pushvars.server which defualts to False. This config controls whether the
server to unbundle the variables send by pushvars.

To make sure nothing breaks for those with pushvars extension enabled,
this should be added to the configuration file:

[push]
pushvars.server = True

Diff Detail

Repository

rFBHGX Facebook Mercurial Extensions

Lint

Lint Skipped

Unit

Unit Tests Skipped

Event Timeline

pulkit created this revision.Aug 22 2017, 8:02 AM

Herald added a reviewer: Restricted Project. · View Herald TranscriptAug 22 2017, 8:02 AM

pulkit added a subscriber: ryanmce.Aug 22 2017, 8:06 AM

@kulshrax is running the current release, and he's the one that can verify this all works as intended.

@pulkit, feel free to comandeer the revision that I commandeered from you if you want; that way all the history is in one place.

In D473#7483, @ryanmce wrote:

@kulshrax is running the current release, and he's the one that can verify this all works as intended.
@pulkit, feel free to comandeer the revision that I commandeered from you if you want; that way all the history is in one place.

Commandeered https://phab.mercurial-scm.org/D365.

I think this could be abandoned since D365 was pushed.

This revision now requires changes to proceed.Aug 23 2017, 12:02 AM

pulkit abandoned this revision.Aug 23 2017, 2:32 PM

Revision Contents
Changeset List

			Path	Packages
M			hgext3rd/pushvars.py (83 lines)
M			tests/test-pushvars.t (3 lines)

Diff 1154

hgext3rd/pushvars.py

	# pushvars.py - enable pushing environment variables to the server			# pushvars.py -- extension for setting environment variables on the server-side
				# during pushes.
	#			#
	# Copyright 2015 Facebook, Inc.			# Copyright 2017 Facebook, Inc.
	#			#
	# This software may be used and distributed according to the terms of the			# This software may be used and distributed according to the terms of the
	# GNU General Public License version 2 or any later version.			# GNU General Public License version 2 or any later version.
	#
	# When we want to modify how a hook works or to disable it, we
	# can send environment variables that the hooks can read. The
	# environment variables are prepended with HG_USERVAR_ and are thus
	# not a security vulnerability. For example:
	#
	# hg push --pushvars="BYPASS_REVIEWERS=true" --pushvars="DEBUG=1"
	#
	# will result in both HG_USERVAR_BYPASS_REVIEWERS and HG_USERVAR_DEBUG
	# available to the hook environment.

	from mercurial import bundle2, exchange, extensions, registrar
	from mercurial import error, commands
	from mercurial.i18n import _

	cmdtable = {}
	command = registrar.command(cmdtable)

	@exchange.b2partsgenerator('pushvars')
	def _getbundlesendvars(pushop, bundler):
	'''send shellvars via bundle2'''
	if getattr(pushop.repo, '_shellvars', ()):
	part = bundler.newpart('pushvars')
	for entry in pushop.repo._shellvars:
	try:
	key, value = entry.split('=', 1)
	except Exception:
	raise error.Abort(
	_('passed in variable needs to be of form var= or var=val. '
	'Instead, this was given "%s"') % entry)
	part.addparam(key, value, mandatory=False)

	# Ugly hack suggested by pyd to ensure pushvars part comes before
	# hook part. Pyd has a fix for this in in he works.
	exchange.b2partsgenorder.insert(0, exchange.b2partsgenorder.pop())

	# Eventually, this will be used when we update to an Hg that supports this.
	#@exchange.b2partsgenerator('pushvars', idx=0)

	@bundle2.parthandler('pushvars')
	def bundle2getvars(op, part):
	'''unbundle a bundle2 containing shellvars on the server'''
	hookargs = {}
	for key, value in part.advisoryparams:
	key = key.upper()
	# We want pushed variables to have USERVAR_ prepended so we know
	# they came from the pushvar extension.
	key = "USERVAR_" + key
	hookargs[key] = value
	op.addhookargs(hookargs)

	def push(orig, ui, repo, args, *opts):
	repo._shellvars = opts['pushvars']
	try:
	return orig(ui, repo, args, *opts)
	finally:
	del repo._shellvars

	def uisetup(ui):
	# remotenames circumvents the default push implementation entirely, so make
	# sure we load after it so that we wrap it.
	order = list(extensions._order)
	order.remove('pushvars')
	order.append('pushvars')
	extensions._order = order

	def extsetup(ui):			def reposetup(ui, repo):
	entry = extensions.wrapcommand(commands.table, 'push', push)			"""
	entry[1].append(('', 'pushvars', [],			The main pushvars functionality moved into core hg. However, the behavior
	"variables that can be sent to the server"))			of the core version differs from this extension, which originally would
				set the environment variables on the server by default when the extension
				was enabled. To keep that behavior, this extension now just sets the option.
				This makes the transition painless.
				"""
				repo.ui.setconfig('push', 'pushvars.server', True)

tests/test-pushvars.t

	Setup			Setup

	$ PYTHONPATH=$TESTDIR/..:$PYTHONPATH			$ PYTHONPATH=$TESTDIR/..:$PYTHONPATH
	$ export PYTHONPATH			$ export PYTHONPATH

	$ cat > $TESTTMP/pretxnchangegroup.sh << EOF			$ cat > $TESTTMP/pretxnchangegroup.sh << EOF
	> #!/bin/bash			> #!/bin/bash
	> env \| grep -E "^HG_USERVAR_DEBUG"			> env \| grep -E "^HG_USERVAR_DEBUG"
	> env \| grep -E "^HG_USERVAR_BYPASS_REVIEW"			> env \| grep -E "^HG_USERVAR_BYPASS_REVIEW"
	> exit 0			> exit 0
	> EOF			> EOF
	$ chmod +x $TESTTMP/pretxnchangegroup.sh			$ chmod +x $TESTTMP/pretxnchangegroup.sh
	$ cat >> $HGRCPATH << EOF			$ cat >> $HGRCPATH << EOF
	> [extensions]			> [extensions]
	> bundle2hooks=$TESTDIR/../hgext3rd/bundle2hooks.py
	> pushvars=$TESTDIR/../hgext3rd/pushvars.py			> pushvars=$TESTDIR/../hgext3rd/pushvars.py
	> [hooks]			> [hooks]
	> pretxnchangegroup = $TESTTMP/pretxnchangegroup.sh			> pretxnchangegroup = $TESTTMP/pretxnchangegroup.sh
	> [experimental]			> [experimental]
	> bundle2-exp = true			> bundle2-exp = true
	> EOF			> EOF

	$ hg init repo			$ hg init repo

	Test pushing bad vars			Test pushing bad vars

	$ echo b >> a			$ echo b >> a
	$ hg commit -Aqm b			$ hg commit -Aqm b
	$ hg push --pushvars "DEBUG"			$ hg push --pushvars "DEBUG"
	pushing to $TESTTMP/repo (glob)			pushing to $TESTTMP/repo (glob)
	searching for changes			searching for changes
	abort: passed in variable needs to be of form var= or var=val. Instead, this was given "DEBUG"			abort: unable to parse variable 'DEBUG', should follow 'KEY=VALUE' or 'KEY=' format
	[255]			[255]

Diff	ID	Base	Description	Created	Lint	Unit
Base			Base
Diff 1	1154			Aug 22 2017, 8:02 AM	★	★